blob: 64646b461cebe6c0fcac55272241c2901eca38e6 [file] [log] [blame]
Francis Murtagh1f7db452019-08-14 09:49:34 +01001//
2// Copyright © 2017 Arm Ltd. All rights reserved.
3// SPDX-License-Identifier: MIT
4//
5
Matteo Martincighd0613b52019-10-09 16:47:04 +01006#include "ProfilingTests.hpp"
Keith Davis33ed2212020-03-30 10:43:41 +01007#include "ProfilingTestUtils.hpp"
Teresa Charlin9bab4962019-09-06 12:28:35 +01008
James Conroy2dcd3fe2020-02-06 18:34:52 +00009#include <backends/BackendProfiling.hpp>
Matteo Martincigh8a837172019-10-04 17:01:07 +010010#include <CommandHandler.hpp>
Matteo Martincigh6db5f202019-09-05 12:02:04 +010011#include <CommandHandlerKey.hpp>
Matteo Martincigh6db5f202019-09-05 12:02:04 +010012#include <CommandHandlerRegistry.hpp>
Sadik Armagana97a0be2020-03-03 10:44:56 +000013#include <common/include/SocketConnectionException.hpp>
Sadik Armaganb5f01b22019-09-18 17:29:00 +010014#include <ConnectionAcknowledgedCommandHandler.hpp>
Matteo Martincigh6db5f202019-09-05 12:02:04 +010015#include <CounterDirectory.hpp>
David Monahande803072020-01-30 12:44:23 +000016#include <CounterIdMap.hpp>
Matteo Martincigh6db5f202019-09-05 12:02:04 +010017#include <EncodeVersion.hpp>
18#include <Holder.hpp>
Matteo Martincighe0e6efc2019-10-04 17:17:42 +010019#include <ICounterValues.hpp>
Matteo Martincigh6db5f202019-09-05 12:02:04 +010020#include <Packet.hpp>
21#include <PacketVersionResolver.hpp>
Francis Murtaghfcb8ef62019-09-20 15:40:09 +010022#include <PeriodicCounterCapture.hpp>
Matteo Martincigh6db5f202019-09-05 12:02:04 +010023#include <PeriodicCounterSelectionCommandHandler.hpp>
24#include <ProfilingStateMachine.hpp>
Matteo Martincigh6db5f202019-09-05 12:02:04 +010025#include <ProfilingUtils.hpp>
James Conroy2dcd3fe2020-02-06 18:34:52 +000026#include <RegisterBackendCounters.hpp>
Narumol Prangnawarat48033692019-09-20 12:04:55 +010027#include <RequestCounterDirectoryCommandHandler.hpp>
Teresa Charlin9bab4962019-09-06 12:28:35 +010028#include <Runtime.hpp>
Matteo Martincigh6db5f202019-09-05 12:02:04 +010029#include <SocketProfilingConnection.hpp>
Matteo Martincighcdfb9412019-11-08 11:23:06 +000030#include <SendCounterPacket.hpp>
Sadik Armagan3896b472020-02-10 12:24:15 +000031#include <SendThread.hpp>
Matteo Martincighcdfb9412019-11-08 11:23:06 +000032#include <SendTimelinePacket.hpp>
Keith Davis02356de2019-08-26 18:28:17 +010033
Matteo Martincigh6db5f202019-09-05 12:02:04 +010034#include <armnn/Conversion.hpp>
Colm Donelan02705242019-11-14 14:19:07 +000035#include <armnn/Types.hpp>
Ferran Balaguer1b941722019-08-28 16:57:18 +010036
Matteo Martincigh54fb9572019-10-02 12:50:57 +010037#include <armnn/Utils.hpp>
Jan Eilers8eb25602020-03-09 12:13:48 +000038#include <armnn/utility/IgnoreUnused.hpp>
Matteo Martincigh54fb9572019-10-02 12:50:57 +010039
Ferran Balaguer1b941722019-08-28 16:57:18 +010040#include <boost/numeric/conversion/cast.hpp>
Francis Murtagh1f7db452019-08-14 09:49:34 +010041
Nikhil Rajbc626052019-08-15 15:49:45 +010042#include <cstdint>
43#include <cstring>
Keith Davis3201eea2019-10-24 17:30:41 +010044#include <iostream>
Aron Virginas-Tare898db92019-08-22 12:56:34 +010045#include <limits>
Francis Murtagh11f99b42019-08-16 11:28:52 +010046#include <map>
Aron Virginas-Tare898db92019-08-22 12:56:34 +010047#include <random>
James Conroy2dcd3fe2020-02-06 18:34:52 +000048
Francis Murtagh1f7db452019-08-14 09:49:34 +010049
Aron Virginas-Tare898db92019-08-22 12:56:34 +010050using namespace armnn::profiling;
Finn Williams09ad6f92019-12-19 17:05:18 +000051using PacketType = MockProfilingConnection::PacketType;
Aron Virginas-Tare898db92019-08-22 12:56:34 +010052
Matteo Martincigh8a837172019-10-04 17:01:07 +010053BOOST_AUTO_TEST_SUITE(ExternalProfiling)
54
Francis Murtagh1f7db452019-08-14 09:49:34 +010055BOOST_AUTO_TEST_CASE(CheckCommandHandlerKeyComparisons)
56{
Jim Flynn397043f2019-10-17 17:37:10 +010057 CommandHandlerKey testKey1_0(1, 1, 1);
58 CommandHandlerKey testKey1_1(1, 1, 1);
59 CommandHandlerKey testKey1_2(1, 2, 1);
60
61 CommandHandlerKey testKey0(0, 1, 1);
62 CommandHandlerKey testKey1(0, 1, 1);
63 CommandHandlerKey testKey2(0, 1, 1);
64 CommandHandlerKey testKey3(0, 0, 0);
65 CommandHandlerKey testKey4(0, 2, 2);
66 CommandHandlerKey testKey5(0, 0, 2);
67
68 BOOST_CHECK(testKey1_0 > testKey0);
69 BOOST_CHECK(testKey1_0 == testKey1_1);
70 BOOST_CHECK(testKey1_0 < testKey1_2);
Francis Murtagh1f7db452019-08-14 09:49:34 +010071
Keith Davis3201eea2019-10-24 17:30:41 +010072 BOOST_CHECK(testKey1 < testKey4);
73 BOOST_CHECK(testKey1 > testKey3);
74 BOOST_CHECK(testKey1 <= testKey4);
75 BOOST_CHECK(testKey1 >= testKey3);
76 BOOST_CHECK(testKey1 <= testKey2);
77 BOOST_CHECK(testKey1 >= testKey2);
78 BOOST_CHECK(testKey1 == testKey2);
79 BOOST_CHECK(testKey1 == testKey1);
Francis Murtagh1f7db452019-08-14 09:49:34 +010080
Keith Davis3201eea2019-10-24 17:30:41 +010081 BOOST_CHECK(!(testKey1 == testKey5));
82 BOOST_CHECK(!(testKey1 != testKey1));
83 BOOST_CHECK(testKey1 != testKey5);
Francis Murtagh1f7db452019-08-14 09:49:34 +010084
Keith Davis3201eea2019-10-24 17:30:41 +010085 BOOST_CHECK(testKey1 == testKey2 && testKey2 == testKey1);
86 BOOST_CHECK(testKey0 == testKey1 && testKey1 == testKey2 && testKey0 == testKey2);
Francis Murtagh1f7db452019-08-14 09:49:34 +010087
Keith Davis3201eea2019-10-24 17:30:41 +010088 BOOST_CHECK(testKey1.GetPacketId() == 1);
89 BOOST_CHECK(testKey1.GetVersion() == 1);
Francis Murtagh1f7db452019-08-14 09:49:34 +010090
Keith Davis3201eea2019-10-24 17:30:41 +010091 std::vector<CommandHandlerKey> vect = { CommandHandlerKey(0, 0, 1), CommandHandlerKey(0, 2, 0),
92 CommandHandlerKey(0, 1, 0), CommandHandlerKey(0, 2, 1),
93 CommandHandlerKey(0, 1, 1), CommandHandlerKey(0, 0, 1),
94 CommandHandlerKey(0, 2, 0), CommandHandlerKey(0, 0, 0) };
Francis Murtagh1f7db452019-08-14 09:49:34 +010095
96 std::sort(vect.begin(), vect.end());
97
Keith Davis3201eea2019-10-24 17:30:41 +010098 std::vector<CommandHandlerKey> expectedVect = { CommandHandlerKey(0, 0, 0), CommandHandlerKey(0, 0, 1),
99 CommandHandlerKey(0, 0, 1), CommandHandlerKey(0, 1, 0),
100 CommandHandlerKey(0, 1, 1), CommandHandlerKey(0, 2, 0),
101 CommandHandlerKey(0, 2, 0), CommandHandlerKey(0, 2, 1) };
Francis Murtagh1f7db452019-08-14 09:49:34 +0100102
103 BOOST_CHECK(vect == expectedVect);
104}
105
Jim Flynned25e0e2019-10-18 13:21:43 +0100106BOOST_AUTO_TEST_CASE(CheckPacketKeyComparisons)
107{
Keith Davis3201eea2019-10-24 17:30:41 +0100108 PacketKey key0(0, 0);
109 PacketKey key1(0, 0);
110 PacketKey key2(0, 1);
111 PacketKey key3(0, 2);
112 PacketKey key4(1, 0);
113 PacketKey key5(1, 0);
114 PacketKey key6(1, 1);
Jim Flynned25e0e2019-10-18 13:21:43 +0100115
116 BOOST_CHECK(!(key0 < key1));
117 BOOST_CHECK(!(key0 > key1));
118 BOOST_CHECK(key0 <= key1);
119 BOOST_CHECK(key0 >= key1);
120 BOOST_CHECK(key0 == key1);
121 BOOST_CHECK(key0 < key2);
122 BOOST_CHECK(key2 < key3);
123 BOOST_CHECK(key3 > key0);
124 BOOST_CHECK(key4 == key5);
125 BOOST_CHECK(key4 > key0);
126 BOOST_CHECK(key5 < key6);
127 BOOST_CHECK(key5 <= key6);
128 BOOST_CHECK(key5 != key6);
129}
130
Matteo Martincigh8a837172019-10-04 17:01:07 +0100131BOOST_AUTO_TEST_CASE(CheckCommandHandler)
FinnWilliamsArm4833cea2019-09-17 16:53:53 +0100132{
Matteo Martincigh8a837172019-10-04 17:01:07 +0100133 PacketVersionResolver packetVersionResolver;
134 ProfilingStateMachine profilingStateMachine;
FinnWilliamsArm4833cea2019-09-17 16:53:53 +0100135
Matteo Martincigh8a837172019-10-04 17:01:07 +0100136 TestProfilingConnectionBase testProfilingConnectionBase;
137 TestProfilingConnectionTimeoutError testProfilingConnectionTimeOutError;
138 TestProfilingConnectionArmnnError testProfilingConnectionArmnnError;
Keith Davis3201eea2019-10-24 17:30:41 +0100139 CounterDirectory counterDirectory;
140 MockBufferManager mockBuffer(1024);
Sadik Armagan3896b472020-02-10 12:24:15 +0000141 SendCounterPacket sendCounterPacket(mockBuffer);
142 SendThread sendThread(profilingStateMachine, mockBuffer, sendCounterPacket);
Matteo Martincighcdfb9412019-11-08 11:23:06 +0000143 SendTimelinePacket sendTimelinePacket(mockBuffer);
144
Keith Davis3201eea2019-10-24 17:30:41 +0100145 ConnectionAcknowledgedCommandHandler connectionAcknowledgedCommandHandler(0, 1, 4194304, counterDirectory,
Matteo Martincighcdfb9412019-11-08 11:23:06 +0000146 sendCounterPacket, sendTimelinePacket,
147 profilingStateMachine);
Matteo Martincigh8a837172019-10-04 17:01:07 +0100148 CommandHandlerRegistry commandHandlerRegistry;
FinnWilliamsArm4833cea2019-09-17 16:53:53 +0100149
Matteo Martincighc2728f92019-10-07 12:35:21 +0100150 commandHandlerRegistry.RegisterFunctor(&connectionAcknowledgedCommandHandler);
FinnWilliamsArm4833cea2019-09-17 16:53:53 +0100151
Matteo Martincigh8a837172019-10-04 17:01:07 +0100152 profilingStateMachine.TransitionToState(ProfilingState::NotConnected);
153 profilingStateMachine.TransitionToState(ProfilingState::WaitingForAck);
FinnWilliamsArm4833cea2019-09-17 16:53:53 +0100154
Keith Davis3201eea2019-10-24 17:30:41 +0100155 CommandHandler commandHandler0(1, true, commandHandlerRegistry, packetVersionResolver);
FinnWilliamsArm4833cea2019-09-17 16:53:53 +0100156
Colm Donelan2ba48d22019-11-29 09:10:59 +0000157 // This should start the command handler thread return the connection ack and put the profiling
158 // service into active state.
Matteo Martincigh8a837172019-10-04 17:01:07 +0100159 commandHandler0.Start(testProfilingConnectionBase);
Colm Donelan2ba48d22019-11-29 09:10:59 +0000160 // Try to start the send thread many times, it must only start once
Matteo Martincigh8a837172019-10-04 17:01:07 +0100161 commandHandler0.Start(testProfilingConnectionBase);
FinnWilliamsArm4833cea2019-09-17 16:53:53 +0100162
Colm Donelan2ba48d22019-11-29 09:10:59 +0000163 // This could take up to 20mSec but we'll check often.
164 for (int i = 0; i < 10; i++)
Matteo Martincigh8a837172019-10-04 17:01:07 +0100165 {
166 if (profilingStateMachine.GetCurrentState() == ProfilingState::Active)
FinnWilliamsArm4833cea2019-09-17 16:53:53 +0100167 {
Matteo Martincigh8a837172019-10-04 17:01:07 +0100168 break;
FinnWilliamsArm4833cea2019-09-17 16:53:53 +0100169 }
Colm Donelan2ba48d22019-11-29 09:10:59 +0000170 std::this_thread::sleep_for(std::chrono::milliseconds(2));
Matteo Martincigh8a837172019-10-04 17:01:07 +0100171 }
FinnWilliamsArm4833cea2019-09-17 16:53:53 +0100172
Matteo Martincigh8a837172019-10-04 17:01:07 +0100173 BOOST_CHECK(profilingStateMachine.GetCurrentState() == ProfilingState::Active);
FinnWilliamsArm4833cea2019-09-17 16:53:53 +0100174
Colm Donelan2ba48d22019-11-29 09:10:59 +0000175 // Close the thread again.
176 commandHandler0.Stop();
177
178 profilingStateMachine.TransitionToState(ProfilingState::NotConnected);
179 profilingStateMachine.TransitionToState(ProfilingState::WaitingForAck);
180
181 // In this test we'll simulate a timeout without a connection ack packet being received.
182 // Stop after timeout is set so we expect the command handler to stop almost immediately.
183 CommandHandler commandHandler1(1, true, commandHandlerRegistry, packetVersionResolver);
184
185 commandHandler1.Start(testProfilingConnectionTimeOutError);
186 // Wait until we know a timeout exception has been sent at least once.
187 for (int i = 0; i < 10; i++)
188 {
189 if (testProfilingConnectionTimeOutError.ReadCalledCount())
190 {
191 break;
192 }
193 std::this_thread::sleep_for(std::chrono::milliseconds(2));
194 }
Colm Donelan2ba48d22019-11-29 09:10:59 +0000195
196 // The command handler loop should have stopped after the timeout.
Finn Williams09ad6f92019-12-19 17:05:18 +0000197 // wait for the timeout exception to be processed and the loop to break.
198 uint32_t timeout = 50;
199 uint32_t timeSlept = 0;
200 while (commandHandler1.IsRunning())
201 {
202 if (timeSlept >= timeout)
203 {
204 BOOST_FAIL("Timeout: The command handler loop did not stop after the timeout");
205 }
206 std::this_thread::sleep_for(std::chrono::milliseconds(1));
207 timeSlept ++;
208 }
Colm Donelan2ba48d22019-11-29 09:10:59 +0000209
210 commandHandler1.Stop();
211 // The state machine should never have received the ack so will still be in WaitingForAck.
212 BOOST_CHECK(profilingStateMachine.GetCurrentState() == ProfilingState::WaitingForAck);
213
Finn Williams09ad6f92019-12-19 17:05:18 +0000214 // Now try sending a bad connection acknowledged packet
215 TestProfilingConnectionBadAckPacket testProfilingConnectionBadAckPacket;
216 commandHandler1.Start(testProfilingConnectionBadAckPacket);
217 commandHandler1.Stop();
218 // This should also not change the state machine
219 BOOST_CHECK(profilingStateMachine.GetCurrentState() == ProfilingState::WaitingForAck);
220
Colm Donelan2ba48d22019-11-29 09:10:59 +0000221 // Disable stop after timeout and now commandHandler1 should persist after a timeout
222 commandHandler1.SetStopAfterTimeout(false);
223 // Restart the thread.
224 commandHandler1.Start(testProfilingConnectionTimeOutError);
225
226 // Wait for at the three timeouts and the ack to be sent.
227 for (int i = 0; i < 10; i++)
228 {
229 if (testProfilingConnectionTimeOutError.ReadCalledCount() > 3)
230 {
231 break;
232 }
233 std::this_thread::sleep_for(std::chrono::milliseconds(2));
234 }
235 commandHandler1.Stop();
236
237 // Even after the 3 exceptions the ack packet should have transitioned the command handler to active.
238 BOOST_CHECK(profilingStateMachine.GetCurrentState() == ProfilingState::Active);
239
240 // A command handler that gets exceptions other than timeouts should keep going.
241 CommandHandler commandHandler2(1, false, commandHandlerRegistry, packetVersionResolver);
FinnWilliamsArm4833cea2019-09-17 16:53:53 +0100242
Matteo Martincigh8a837172019-10-04 17:01:07 +0100243 commandHandler2.Start(testProfilingConnectionArmnnError);
244
Colm Donelan2ba48d22019-11-29 09:10:59 +0000245 // Wait for two exceptions to be thrown.
246 for (int i = 0; i < 10; i++)
247 {
248 if (testProfilingConnectionTimeOutError.ReadCalledCount() >= 2)
249 {
250 break;
251 }
252 std::this_thread::sleep_for(std::chrono::milliseconds(2));
253 }
FinnWilliamsArm4833cea2019-09-17 16:53:53 +0100254
Matteo Martincighd0613b52019-10-09 16:47:04 +0100255 BOOST_CHECK(commandHandler2.IsRunning());
Matteo Martincigh8a837172019-10-04 17:01:07 +0100256 commandHandler2.Stop();
FinnWilliamsArm4833cea2019-09-17 16:53:53 +0100257}
258
Nikhil Rajd88e47c2019-08-19 10:04:23 +0100259BOOST_AUTO_TEST_CASE(CheckEncodeVersion)
260{
Aron Virginas-Tare898db92019-08-22 12:56:34 +0100261 Version version1(12);
Nikhil Rajd88e47c2019-08-19 10:04:23 +0100262
263 BOOST_CHECK(version1.GetMajor() == 0);
264 BOOST_CHECK(version1.GetMinor() == 0);
265 BOOST_CHECK(version1.GetPatch() == 12);
266
Aron Virginas-Tare898db92019-08-22 12:56:34 +0100267 Version version2(4108);
Nikhil Rajd88e47c2019-08-19 10:04:23 +0100268
269 BOOST_CHECK(version2.GetMajor() == 0);
270 BOOST_CHECK(version2.GetMinor() == 1);
271 BOOST_CHECK(version2.GetPatch() == 12);
272
Aron Virginas-Tare898db92019-08-22 12:56:34 +0100273 Version version3(4198412);
Nikhil Rajd88e47c2019-08-19 10:04:23 +0100274
275 BOOST_CHECK(version3.GetMajor() == 1);
276 BOOST_CHECK(version3.GetMinor() == 1);
277 BOOST_CHECK(version3.GetPatch() == 12);
278
Aron Virginas-Tare898db92019-08-22 12:56:34 +0100279 Version version4(0);
Nikhil Rajd88e47c2019-08-19 10:04:23 +0100280
281 BOOST_CHECK(version4.GetMajor() == 0);
282 BOOST_CHECK(version4.GetMinor() == 0);
283 BOOST_CHECK(version4.GetPatch() == 0);
284
Aron Virginas-Tare898db92019-08-22 12:56:34 +0100285 Version version5(1, 0, 0);
Nikhil Rajd88e47c2019-08-19 10:04:23 +0100286 BOOST_CHECK(version5.GetEncodedValue() == 4194304);
287}
288
Nikhil Rajbc626052019-08-15 15:49:45 +0100289BOOST_AUTO_TEST_CASE(CheckPacketClass)
290{
Keith Davis3201eea2019-10-24 17:30:41 +0100291 uint32_t length = 4;
Matteo Martincigh67ef2a52019-10-10 13:29:02 +0100292 std::unique_ptr<unsigned char[]> packetData0 = std::make_unique<unsigned char[]>(length);
293 std::unique_ptr<unsigned char[]> packetData1 = std::make_unique<unsigned char[]>(0);
294 std::unique_ptr<unsigned char[]> nullPacketData;
Nikhil Rajbc626052019-08-15 15:49:45 +0100295
FinnWilliamsArma0c78712019-09-16 12:06:47 +0100296 Packet packetTest0(472580096, length, packetData0);
Nikhil Rajbc626052019-08-15 15:49:45 +0100297
FinnWilliamsArma0c78712019-09-16 12:06:47 +0100298 BOOST_CHECK(packetTest0.GetHeader() == 472580096);
299 BOOST_CHECK(packetTest0.GetPacketFamily() == 7);
300 BOOST_CHECK(packetTest0.GetPacketId() == 43);
301 BOOST_CHECK(packetTest0.GetLength() == length);
302 BOOST_CHECK(packetTest0.GetPacketType() == 3);
303 BOOST_CHECK(packetTest0.GetPacketClass() == 5);
Nikhil Rajbc626052019-08-15 15:49:45 +0100304
FinnWilliamsArma0c78712019-09-16 12:06:47 +0100305 BOOST_CHECK_THROW(Packet packetTest1(472580096, 0, packetData1), armnn::Exception);
306 BOOST_CHECK_NO_THROW(Packet packetTest2(472580096, 0, nullPacketData));
Nikhil Rajbc626052019-08-15 15:49:45 +0100307
FinnWilliamsArma0c78712019-09-16 12:06:47 +0100308 Packet packetTest3(472580096, 0, nullPacketData);
309 BOOST_CHECK(packetTest3.GetLength() == 0);
310 BOOST_CHECK(packetTest3.GetData() == nullptr);
311
Matteo Martincigh67ef2a52019-10-10 13:29:02 +0100312 const unsigned char* packetTest0Data = packetTest0.GetData();
FinnWilliamsArma0c78712019-09-16 12:06:47 +0100313 Packet packetTest4(std::move(packetTest0));
314
315 BOOST_CHECK(packetTest0.GetData() == nullptr);
316 BOOST_CHECK(packetTest4.GetData() == packetTest0Data);
317
318 BOOST_CHECK(packetTest4.GetHeader() == 472580096);
319 BOOST_CHECK(packetTest4.GetPacketFamily() == 7);
320 BOOST_CHECK(packetTest4.GetPacketId() == 43);
321 BOOST_CHECK(packetTest4.GetLength() == length);
322 BOOST_CHECK(packetTest4.GetPacketType() == 3);
323 BOOST_CHECK(packetTest4.GetPacketClass() == 5);
Nikhil Rajbc626052019-08-15 15:49:45 +0100324}
325
Francis Murtagh11f99b42019-08-16 11:28:52 +0100326BOOST_AUTO_TEST_CASE(CheckCommandHandlerFunctor)
327{
Francis Murtagh11f99b42019-08-16 11:28:52 +0100328 // Hard code the version as it will be the same during a single profiling session
329 uint32_t version = 1;
330
Jim Flynn397043f2019-10-17 17:37:10 +0100331 TestFunctorA testFunctorA(7, 461, version);
332 TestFunctorB testFunctorB(8, 963, version);
333 TestFunctorC testFunctorC(5, 983, version);
Francis Murtagh11f99b42019-08-16 11:28:52 +0100334
Jim Flynn397043f2019-10-17 17:37:10 +0100335 CommandHandlerKey keyA(testFunctorA.GetFamilyId(), testFunctorA.GetPacketId(), testFunctorA.GetVersion());
336 CommandHandlerKey keyB(testFunctorB.GetFamilyId(), testFunctorB.GetPacketId(), testFunctorB.GetVersion());
337 CommandHandlerKey keyC(testFunctorC.GetFamilyId(), testFunctorC.GetPacketId(), testFunctorC.GetVersion());
Francis Murtagh11f99b42019-08-16 11:28:52 +0100338
339 // Create the unwrapped map to simulate the Command Handler Registry
340 std::map<CommandHandlerKey, CommandHandlerFunctor*> registry;
341
342 registry.insert(std::make_pair(keyB, &testFunctorB));
343 registry.insert(std::make_pair(keyA, &testFunctorA));
344 registry.insert(std::make_pair(keyC, &testFunctorC));
345
346 // Check the order of the map is correct
347 auto it = registry.begin();
Keith Davis3201eea2019-10-24 17:30:41 +0100348 BOOST_CHECK(it->first == keyC); // familyId == 5
Francis Murtagh11f99b42019-08-16 11:28:52 +0100349 it++;
Keith Davis3201eea2019-10-24 17:30:41 +0100350 BOOST_CHECK(it->first == keyA); // familyId == 7
Francis Murtagh11f99b42019-08-16 11:28:52 +0100351 it++;
Keith Davis3201eea2019-10-24 17:30:41 +0100352 BOOST_CHECK(it->first == keyB); // familyId == 8
Francis Murtagh11f99b42019-08-16 11:28:52 +0100353
Matteo Martincigh67ef2a52019-10-10 13:29:02 +0100354 std::unique_ptr<unsigned char[]> packetDataA;
355 std::unique_ptr<unsigned char[]> packetDataB;
356 std::unique_ptr<unsigned char[]> packetDataC;
FinnWilliamsArma0c78712019-09-16 12:06:47 +0100357
358 Packet packetA(500000000, 0, packetDataA);
359 Packet packetB(600000000, 0, packetDataB);
360 Packet packetC(400000000, 0, packetDataC);
Francis Murtagh11f99b42019-08-16 11:28:52 +0100361
362 // Check the correct operator of derived class is called
Jim Flynn397043f2019-10-17 17:37:10 +0100363 registry.at(CommandHandlerKey(packetA.GetPacketFamily(), packetA.GetPacketId(), version))->operator()(packetA);
Francis Murtagh11f99b42019-08-16 11:28:52 +0100364 BOOST_CHECK(testFunctorA.GetCount() == 1);
365 BOOST_CHECK(testFunctorB.GetCount() == 0);
366 BOOST_CHECK(testFunctorC.GetCount() == 0);
367
Jim Flynn397043f2019-10-17 17:37:10 +0100368 registry.at(CommandHandlerKey(packetB.GetPacketFamily(), packetB.GetPacketId(), version))->operator()(packetB);
Francis Murtagh11f99b42019-08-16 11:28:52 +0100369 BOOST_CHECK(testFunctorA.GetCount() == 1);
370 BOOST_CHECK(testFunctorB.GetCount() == 1);
371 BOOST_CHECK(testFunctorC.GetCount() == 0);
372
Jim Flynn397043f2019-10-17 17:37:10 +0100373 registry.at(CommandHandlerKey(packetC.GetPacketFamily(), packetC.GetPacketId(), version))->operator()(packetC);
Francis Murtagh11f99b42019-08-16 11:28:52 +0100374 BOOST_CHECK(testFunctorA.GetCount() == 1);
375 BOOST_CHECK(testFunctorB.GetCount() == 1);
376 BOOST_CHECK(testFunctorC.GetCount() == 1);
377}
378
Francis Murtagh94d79152019-08-16 17:45:07 +0100379BOOST_AUTO_TEST_CASE(CheckCommandHandlerRegistry)
380{
381 // Hard code the version as it will be the same during a single profiling session
382 uint32_t version = 1;
383
Jim Flynn397043f2019-10-17 17:37:10 +0100384 TestFunctorA testFunctorA(7, 461, version);
385 TestFunctorB testFunctorB(8, 963, version);
386 TestFunctorC testFunctorC(5, 983, version);
Francis Murtagh94d79152019-08-16 17:45:07 +0100387
388 // Create the Command Handler Registry
389 CommandHandlerRegistry registry;
390
391 // Register multiple different derived classes
Matteo Martincighc2728f92019-10-07 12:35:21 +0100392 registry.RegisterFunctor(&testFunctorA);
393 registry.RegisterFunctor(&testFunctorB);
394 registry.RegisterFunctor(&testFunctorC);
Francis Murtagh94d79152019-08-16 17:45:07 +0100395
Matteo Martincigh67ef2a52019-10-10 13:29:02 +0100396 std::unique_ptr<unsigned char[]> packetDataA;
397 std::unique_ptr<unsigned char[]> packetDataB;
398 std::unique_ptr<unsigned char[]> packetDataC;
FinnWilliamsArma0c78712019-09-16 12:06:47 +0100399
400 Packet packetA(500000000, 0, packetDataA);
401 Packet packetB(600000000, 0, packetDataB);
402 Packet packetC(400000000, 0, packetDataC);
Francis Murtagh94d79152019-08-16 17:45:07 +0100403
404 // Check the correct operator of derived class is called
Jim Flynn397043f2019-10-17 17:37:10 +0100405 registry.GetFunctor(packetA.GetPacketFamily(), packetA.GetPacketId(), version)->operator()(packetA);
Francis Murtagh94d79152019-08-16 17:45:07 +0100406 BOOST_CHECK(testFunctorA.GetCount() == 1);
407 BOOST_CHECK(testFunctorB.GetCount() == 0);
408 BOOST_CHECK(testFunctorC.GetCount() == 0);
409
Jim Flynn397043f2019-10-17 17:37:10 +0100410 registry.GetFunctor(packetB.GetPacketFamily(), packetB.GetPacketId(), version)->operator()(packetB);
Francis Murtagh94d79152019-08-16 17:45:07 +0100411 BOOST_CHECK(testFunctorA.GetCount() == 1);
412 BOOST_CHECK(testFunctorB.GetCount() == 1);
413 BOOST_CHECK(testFunctorC.GetCount() == 0);
414
Jim Flynn397043f2019-10-17 17:37:10 +0100415 registry.GetFunctor(packetC.GetPacketFamily(), packetC.GetPacketId(), version)->operator()(packetC);
Francis Murtagh94d79152019-08-16 17:45:07 +0100416 BOOST_CHECK(testFunctorA.GetCount() == 1);
417 BOOST_CHECK(testFunctorB.GetCount() == 1);
418 BOOST_CHECK(testFunctorC.GetCount() == 1);
419
420 // Re-register an existing key with a new function
Jim Flynn397043f2019-10-17 17:37:10 +0100421 registry.RegisterFunctor(&testFunctorC, testFunctorA.GetFamilyId(), testFunctorA.GetPacketId(), version);
422 registry.GetFunctor(packetA.GetPacketFamily(), packetA.GetPacketId(), version)->operator()(packetC);
Francis Murtagh94d79152019-08-16 17:45:07 +0100423 BOOST_CHECK(testFunctorA.GetCount() == 1);
424 BOOST_CHECK(testFunctorB.GetCount() == 1);
425 BOOST_CHECK(testFunctorC.GetCount() == 2);
426
427 // Check that non-existent key returns nullptr for its functor
Jim Flynn397043f2019-10-17 17:37:10 +0100428 BOOST_CHECK_THROW(registry.GetFunctor(0, 0, 0), armnn::Exception);
Francis Murtagh94d79152019-08-16 17:45:07 +0100429}
430
Aron Virginas-Tare898db92019-08-22 12:56:34 +0100431BOOST_AUTO_TEST_CASE(CheckPacketVersionResolver)
432{
433 // Set up random number generator for generating packetId values
434 std::random_device device;
435 std::mt19937 generator(device());
436 std::uniform_int_distribution<uint32_t> distribution(std::numeric_limits<uint32_t>::min(),
437 std::numeric_limits<uint32_t>::max());
438
439 // NOTE: Expected version is always 1.0.0, regardless of packetId
440 const Version expectedVersion(1, 0, 0);
441
442 PacketVersionResolver packetVersionResolver;
443
444 constexpr unsigned int numTests = 10u;
445
446 for (unsigned int i = 0u; i < numTests; ++i)
447 {
Jim Flynned25e0e2019-10-18 13:21:43 +0100448 const uint32_t familyId = distribution(generator);
Aron Virginas-Tare898db92019-08-22 12:56:34 +0100449 const uint32_t packetId = distribution(generator);
Jim Flynned25e0e2019-10-18 13:21:43 +0100450 Version resolvedVersion = packetVersionResolver.ResolvePacketVersion(familyId, packetId);
Aron Virginas-Tare898db92019-08-22 12:56:34 +0100451
452 BOOST_TEST(resolvedVersion == expectedVersion);
453 }
454}
Matteo Martincighd0613b52019-10-09 16:47:04 +0100455
Nikhil Raj3ecc5102019-09-03 15:55:33 +0100456void ProfilingCurrentStateThreadImpl(ProfilingStateMachine& states)
457{
458 ProfilingState newState = ProfilingState::NotConnected;
459 states.GetCurrentState();
460 states.TransitionToState(newState);
461}
462
463BOOST_AUTO_TEST_CASE(CheckProfilingStateMachine)
464{
465 ProfilingStateMachine profilingState1(ProfilingState::Uninitialised);
466 profilingState1.TransitionToState(ProfilingState::Uninitialised);
Keith Davis3201eea2019-10-24 17:30:41 +0100467 BOOST_CHECK(profilingState1.GetCurrentState() == ProfilingState::Uninitialised);
Nikhil Raj3ecc5102019-09-03 15:55:33 +0100468
469 ProfilingStateMachine profilingState2(ProfilingState::Uninitialised);
470 profilingState2.TransitionToState(ProfilingState::NotConnected);
471 BOOST_CHECK(profilingState2.GetCurrentState() == ProfilingState::NotConnected);
472
473 ProfilingStateMachine profilingState3(ProfilingState::NotConnected);
474 profilingState3.TransitionToState(ProfilingState::NotConnected);
475 BOOST_CHECK(profilingState3.GetCurrentState() == ProfilingState::NotConnected);
476
477 ProfilingStateMachine profilingState4(ProfilingState::NotConnected);
478 profilingState4.TransitionToState(ProfilingState::WaitingForAck);
479 BOOST_CHECK(profilingState4.GetCurrentState() == ProfilingState::WaitingForAck);
480
481 ProfilingStateMachine profilingState5(ProfilingState::WaitingForAck);
482 profilingState5.TransitionToState(ProfilingState::WaitingForAck);
483 BOOST_CHECK(profilingState5.GetCurrentState() == ProfilingState::WaitingForAck);
484
485 ProfilingStateMachine profilingState6(ProfilingState::WaitingForAck);
486 profilingState6.TransitionToState(ProfilingState::Active);
487 BOOST_CHECK(profilingState6.GetCurrentState() == ProfilingState::Active);
488
489 ProfilingStateMachine profilingState7(ProfilingState::Active);
490 profilingState7.TransitionToState(ProfilingState::NotConnected);
491 BOOST_CHECK(profilingState7.GetCurrentState() == ProfilingState::NotConnected);
492
493 ProfilingStateMachine profilingState8(ProfilingState::Active);
494 profilingState8.TransitionToState(ProfilingState::Active);
495 BOOST_CHECK(profilingState8.GetCurrentState() == ProfilingState::Active);
496
497 ProfilingStateMachine profilingState9(ProfilingState::Uninitialised);
Keith Davis3201eea2019-10-24 17:30:41 +0100498 BOOST_CHECK_THROW(profilingState9.TransitionToState(ProfilingState::WaitingForAck), armnn::Exception);
Nikhil Raj3ecc5102019-09-03 15:55:33 +0100499
500 ProfilingStateMachine profilingState10(ProfilingState::Uninitialised);
Keith Davis3201eea2019-10-24 17:30:41 +0100501 BOOST_CHECK_THROW(profilingState10.TransitionToState(ProfilingState::Active), armnn::Exception);
Nikhil Raj3ecc5102019-09-03 15:55:33 +0100502
503 ProfilingStateMachine profilingState11(ProfilingState::NotConnected);
Keith Davis3201eea2019-10-24 17:30:41 +0100504 BOOST_CHECK_THROW(profilingState11.TransitionToState(ProfilingState::Uninitialised), armnn::Exception);
Nikhil Raj3ecc5102019-09-03 15:55:33 +0100505
506 ProfilingStateMachine profilingState12(ProfilingState::NotConnected);
Keith Davis3201eea2019-10-24 17:30:41 +0100507 BOOST_CHECK_THROW(profilingState12.TransitionToState(ProfilingState::Active), armnn::Exception);
Nikhil Raj3ecc5102019-09-03 15:55:33 +0100508
509 ProfilingStateMachine profilingState13(ProfilingState::WaitingForAck);
Keith Davis3201eea2019-10-24 17:30:41 +0100510 BOOST_CHECK_THROW(profilingState13.TransitionToState(ProfilingState::Uninitialised), armnn::Exception);
Nikhil Raj3ecc5102019-09-03 15:55:33 +0100511
512 ProfilingStateMachine profilingState14(ProfilingState::WaitingForAck);
Jim Flynn53e46992019-10-14 12:31:10 +0100513 profilingState14.TransitionToState(ProfilingState::NotConnected);
514 BOOST_CHECK(profilingState14.GetCurrentState() == ProfilingState::NotConnected);
Nikhil Raj3ecc5102019-09-03 15:55:33 +0100515
516 ProfilingStateMachine profilingState15(ProfilingState::Active);
Keith Davis3201eea2019-10-24 17:30:41 +0100517 BOOST_CHECK_THROW(profilingState15.TransitionToState(ProfilingState::Uninitialised), armnn::Exception);
Nikhil Raj3ecc5102019-09-03 15:55:33 +0100518
519 ProfilingStateMachine profilingState16(armnn::profiling::ProfilingState::Active);
Keith Davis3201eea2019-10-24 17:30:41 +0100520 BOOST_CHECK_THROW(profilingState16.TransitionToState(ProfilingState::WaitingForAck), armnn::Exception);
Nikhil Raj3ecc5102019-09-03 15:55:33 +0100521
522 ProfilingStateMachine profilingState17(ProfilingState::Uninitialised);
523
Keith Davis3201eea2019-10-24 17:30:41 +0100524 std::thread thread1(ProfilingCurrentStateThreadImpl, std::ref(profilingState17));
525 std::thread thread2(ProfilingCurrentStateThreadImpl, std::ref(profilingState17));
526 std::thread thread3(ProfilingCurrentStateThreadImpl, std::ref(profilingState17));
527 std::thread thread4(ProfilingCurrentStateThreadImpl, std::ref(profilingState17));
528 std::thread thread5(ProfilingCurrentStateThreadImpl, std::ref(profilingState17));
Nikhil Raj3ecc5102019-09-03 15:55:33 +0100529
530 thread1.join();
531 thread2.join();
532 thread3.join();
533 thread4.join();
534 thread5.join();
535
536 BOOST_TEST((profilingState17.GetCurrentState() == ProfilingState::NotConnected));
537}
Aron Virginas-Tare898db92019-08-22 12:56:34 +0100538
Jim Flynn8355ec92019-09-17 12:29:50 +0100539void CaptureDataWriteThreadImpl(Holder& holder, uint32_t capturePeriod, const std::vector<uint16_t>& counterIds)
Francis Murtagh68f78d82019-09-04 16:42:29 +0100540{
Finn Williams032bc742020-02-12 11:02:34 +0000541 holder.SetCaptureData(capturePeriod, counterIds, {});
Francis Murtagh68f78d82019-09-04 16:42:29 +0100542}
543
Francis Murtaghbd707162019-09-09 11:26:44 +0100544void CaptureDataReadThreadImpl(const Holder& holder, CaptureData& captureData)
Francis Murtagh68f78d82019-09-04 16:42:29 +0100545{
546 captureData = holder.GetCaptureData();
547}
548
549BOOST_AUTO_TEST_CASE(CheckCaptureDataHolder)
550{
Francis Murtaghbd707162019-09-09 11:26:44 +0100551 std::map<uint32_t, std::vector<uint16_t>> periodIdMap;
552 std::vector<uint16_t> counterIds;
Jim Flynn8355ec92019-09-17 12:29:50 +0100553 uint32_t numThreads = 10;
554 for (uint32_t i = 0; i < numThreads; ++i)
Francis Murtaghbd707162019-09-09 11:26:44 +0100555 {
556 counterIds.emplace_back(i);
557 periodIdMap.insert(std::make_pair(i, counterIds));
558 }
Francis Murtagh68f78d82019-09-04 16:42:29 +0100559
Jim Flynn8355ec92019-09-17 12:29:50 +0100560 // Verify the read and write threads set the holder correctly
561 // and retrieve the expected values
Francis Murtagh68f78d82019-09-04 16:42:29 +0100562 Holder holder;
563 BOOST_CHECK((holder.GetCaptureData()).GetCapturePeriod() == 0);
564 BOOST_CHECK(((holder.GetCaptureData()).GetCounterIds()).empty());
565
566 // Check Holder functions
Francis Murtaghbd707162019-09-09 11:26:44 +0100567 std::thread thread1(CaptureDataWriteThreadImpl, std::ref(holder), 2, std::ref(periodIdMap[2]));
Francis Murtagh68f78d82019-09-04 16:42:29 +0100568 thread1.join();
Francis Murtaghbd707162019-09-09 11:26:44 +0100569 BOOST_CHECK((holder.GetCaptureData()).GetCapturePeriod() == 2);
570 BOOST_CHECK((holder.GetCaptureData()).GetCounterIds() == periodIdMap[2]);
Jim Flynn8355ec92019-09-17 12:29:50 +0100571 // NOTE: now that we have some initial values in the holder we don't have to worry
572 // in the multi-threaded section below about a read thread accessing the holder
573 // before any write thread has gotten to it so we read period = 0, counterIds empty
574 // instead of period = 0, counterIds = {0} as will the case when write thread 0
575 // has executed.
Francis Murtagh68f78d82019-09-04 16:42:29 +0100576
577 CaptureData captureData;
578 std::thread thread2(CaptureDataReadThreadImpl, std::ref(holder), std::ref(captureData));
579 thread2.join();
Jim Flynn8355ec92019-09-17 12:29:50 +0100580 BOOST_CHECK(captureData.GetCapturePeriod() == 2);
Francis Murtaghbd707162019-09-09 11:26:44 +0100581 BOOST_CHECK(captureData.GetCounterIds() == periodIdMap[2]);
Francis Murtagh68f78d82019-09-04 16:42:29 +0100582
Jim Flynn8355ec92019-09-17 12:29:50 +0100583 std::map<uint32_t, CaptureData> captureDataIdMap;
584 for (uint32_t i = 0; i < numThreads; ++i)
585 {
586 CaptureData perThreadCaptureData;
587 captureDataIdMap.insert(std::make_pair(i, perThreadCaptureData));
588 }
589
Francis Murtaghbd707162019-09-09 11:26:44 +0100590 std::vector<std::thread> threadsVect;
Jim Flynn8355ec92019-09-17 12:29:50 +0100591 std::vector<std::thread> readThreadsVect;
592 for (uint32_t i = 0; i < numThreads; ++i)
Francis Murtaghbd707162019-09-09 11:26:44 +0100593 {
Keith Davis3201eea2019-10-24 17:30:41 +0100594 threadsVect.emplace_back(
595 std::thread(CaptureDataWriteThreadImpl, std::ref(holder), i, std::ref(periodIdMap[i])));
Francis Murtagh06965692019-09-05 16:29:01 +0100596
Jim Flynn8355ec92019-09-17 12:29:50 +0100597 // Verify that the CaptureData goes into the thread in a virgin state
598 BOOST_CHECK(captureDataIdMap.at(i).GetCapturePeriod() == 0);
599 BOOST_CHECK(captureDataIdMap.at(i).GetCounterIds().empty());
Keith Davis3201eea2019-10-24 17:30:41 +0100600 readThreadsVect.emplace_back(
601 std::thread(CaptureDataReadThreadImpl, std::ref(holder), std::ref(captureDataIdMap.at(i))));
Francis Murtaghbd707162019-09-09 11:26:44 +0100602 }
603
Jim Flynn8355ec92019-09-17 12:29:50 +0100604 for (uint32_t i = 0; i < numThreads; ++i)
Francis Murtaghbd707162019-09-09 11:26:44 +0100605 {
606 threadsVect[i].join();
Francis Murtaghbd707162019-09-09 11:26:44 +0100607 readThreadsVect[i].join();
608 }
Francis Murtagh68f78d82019-09-04 16:42:29 +0100609
Jim Flynn8355ec92019-09-17 12:29:50 +0100610 // Look at the CaptureData that each read thread has filled
611 // the capture period it read should match the counter ids entry
612 for (uint32_t i = 0; i < numThreads; ++i)
613 {
614 CaptureData perThreadCaptureData = captureDataIdMap.at(i);
615 BOOST_CHECK(perThreadCaptureData.GetCounterIds() == periodIdMap.at(perThreadCaptureData.GetCapturePeriod()));
616 }
Matthew Bentham46d1c622019-09-13 12:45:04 +0100617}
Francis Murtagh68f78d82019-09-04 16:42:29 +0100618
Matthew Bentham46d1c622019-09-13 12:45:04 +0100619BOOST_AUTO_TEST_CASE(CaptureDataMethods)
620{
Jim Flynn8355ec92019-09-17 12:29:50 +0100621 // Check CaptureData setter and getter functions
Keith Davis3201eea2019-10-24 17:30:41 +0100622 std::vector<uint16_t> counterIds = { 42, 29, 13 };
Jim Flynn8355ec92019-09-17 12:29:50 +0100623 CaptureData captureData;
624 BOOST_CHECK(captureData.GetCapturePeriod() == 0);
625 BOOST_CHECK((captureData.GetCounterIds()).empty());
626 captureData.SetCapturePeriod(150);
627 captureData.SetCounterIds(counterIds);
628 BOOST_CHECK(captureData.GetCapturePeriod() == 150);
629 BOOST_CHECK(captureData.GetCounterIds() == counterIds);
Francis Murtagh68f78d82019-09-04 16:42:29 +0100630
Jim Flynn8355ec92019-09-17 12:29:50 +0100631 // Check assignment operator
Francis Murtagh68f78d82019-09-04 16:42:29 +0100632 CaptureData secondCaptureData;
Francis Murtagh68f78d82019-09-04 16:42:29 +0100633
Jim Flynn8355ec92019-09-17 12:29:50 +0100634 secondCaptureData = captureData;
635 BOOST_CHECK(secondCaptureData.GetCapturePeriod() == 150);
Matthew Bentham46d1c622019-09-13 12:45:04 +0100636 BOOST_CHECK(secondCaptureData.GetCounterIds() == counterIds);
Francis Murtagh68f78d82019-09-04 16:42:29 +0100637
638 // Check copy constructor
Jim Flynn8355ec92019-09-17 12:29:50 +0100639 CaptureData copyConstructedCaptureData(captureData);
Francis Murtagh68f78d82019-09-04 16:42:29 +0100640
Jim Flynn8355ec92019-09-17 12:29:50 +0100641 BOOST_CHECK(copyConstructedCaptureData.GetCapturePeriod() == 150);
Matthew Bentham46d1c622019-09-13 12:45:04 +0100642 BOOST_CHECK(copyConstructedCaptureData.GetCounterIds() == counterIds);
Keith Davis02356de2019-08-26 18:28:17 +0100643}
Francis Murtagh68f78d82019-09-04 16:42:29 +0100644
Keith Davis02356de2019-08-26 18:28:17 +0100645BOOST_AUTO_TEST_CASE(CheckProfilingServiceDisabled)
646{
647 armnn::Runtime::CreationOptions::ExternalProfilingOptions options;
Sadik Armagan3184c902020-03-18 10:57:30 +0000648 armnn::profiling::ProfilingService profilingService;
Matteo Martincigha84edee2019-10-02 12:50:57 +0100649 profilingService.ResetExternalProfilingOptions(options, true);
650 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Uninitialised);
Matteo Martincigh54fb9572019-10-02 12:50:57 +0100651 profilingService.Update();
Matteo Martincigha84edee2019-10-02 12:50:57 +0100652 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Uninitialised);
Keith Davis02356de2019-08-26 18:28:17 +0100653}
654
FinnWilliamsArmce2d9d12019-09-18 10:28:16 +0100655BOOST_AUTO_TEST_CASE(CheckProfilingServiceCounterDirectory)
656{
657 armnn::Runtime::CreationOptions::ExternalProfilingOptions options;
Sadik Armagan3184c902020-03-18 10:57:30 +0000658 armnn::profiling::ProfilingService profilingService;
Matteo Martincigha84edee2019-10-02 12:50:57 +0100659 profilingService.ResetExternalProfilingOptions(options, true);
FinnWilliamsArmce2d9d12019-09-18 10:28:16 +0100660
Matteo Martincigha84edee2019-10-02 12:50:57 +0100661 const ICounterDirectory& counterDirectory0 = profilingService.GetCounterDirectory();
FinnWilliamsArmce2d9d12019-09-18 10:28:16 +0100662 BOOST_CHECK(counterDirectory0.GetCounterCount() == 0);
Matteo Martincigh54fb9572019-10-02 12:50:57 +0100663 profilingService.Update();
664 BOOST_CHECK(counterDirectory0.GetCounterCount() == 0);
FinnWilliamsArmce2d9d12019-09-18 10:28:16 +0100665
666 options.m_EnableProfiling = true;
Matteo Martincigha84edee2019-10-02 12:50:57 +0100667 profilingService.ResetExternalProfilingOptions(options);
FinnWilliamsArmce2d9d12019-09-18 10:28:16 +0100668
Matteo Martincigha84edee2019-10-02 12:50:57 +0100669 const ICounterDirectory& counterDirectory1 = profilingService.GetCounterDirectory();
Matteo Martincigh54fb9572019-10-02 12:50:57 +0100670 BOOST_CHECK(counterDirectory1.GetCounterCount() == 0);
671 profilingService.Update();
FinnWilliamsArmce2d9d12019-09-18 10:28:16 +0100672 BOOST_CHECK(counterDirectory1.GetCounterCount() != 0);
Colm Donelan2ba48d22019-11-29 09:10:59 +0000673 // Reset the profiling service to stop any running thread
674 options.m_EnableProfiling = false;
675 profilingService.ResetExternalProfilingOptions(options, true);
FinnWilliamsArmce2d9d12019-09-18 10:28:16 +0100676}
677
FinnWilliamsArmf6e534a2019-09-16 15:45:42 +0100678BOOST_AUTO_TEST_CASE(CheckProfilingServiceCounterValues)
679{
680 armnn::Runtime::CreationOptions::ExternalProfilingOptions options;
Keith Davis3201eea2019-10-24 17:30:41 +0100681 options.m_EnableProfiling = true;
Sadik Armagan3184c902020-03-18 10:57:30 +0000682 armnn::profiling::ProfilingService profilingService;
Matteo Martincigha84edee2019-10-02 12:50:57 +0100683 profilingService.ResetExternalProfilingOptions(options, true);
684
Matteo Martincigh54fb9572019-10-02 12:50:57 +0100685 profilingService.Update();
Matteo Martincigha84edee2019-10-02 12:50:57 +0100686 const ICounterDirectory& counterDirectory = profilingService.GetCounterDirectory();
Keith Davis3201eea2019-10-24 17:30:41 +0100687 const Counters& counters = counterDirectory.GetCounters();
Matteo Martincigha84edee2019-10-02 12:50:57 +0100688 BOOST_CHECK(!counters.empty());
689
Keith Davise394bd92019-12-02 15:12:19 +0000690 // Get the UID of the first counter for testing;
FinnWilliamsArmf6e534a2019-09-16 15:45:42 +0100691
692 ProfilingService* profilingServicePtr = &profilingService;
693 std::vector<std::thread> writers;
694
Jan Eilersa10e2a22020-03-26 12:04:54 +0000695 for (int i = 0; i < 10; ++i)
FinnWilliamsArmf6e534a2019-09-16 15:45:42 +0100696 {
Matteo Martincigha84edee2019-10-02 12:50:57 +0100697 // Increment and decrement the first counter
Keith Davise394bd92019-12-02 15:12:19 +0000698 writers.push_back(std::thread(&ProfilingService::IncrementCounterValue,
699 profilingServicePtr,
700 armnn::profiling::REGISTERED_BACKENDS));
701
702 writers.push_back(std::thread(&ProfilingService::IncrementCounterValue,
703 profilingServicePtr,
704 armnn::profiling::UNREGISTERED_BACKENDS));
705
Matteo Martincigha84edee2019-10-02 12:50:57 +0100706 // Add 10 and subtract 5 from the first counter
Keith Davise394bd92019-12-02 15:12:19 +0000707 writers.push_back(std::thread(&ProfilingService::AddCounterValue,
708 profilingServicePtr,
709 armnn::profiling::INFERENCES_RUN,
710 10));
711 writers.push_back(std::thread(&ProfilingService::SubtractCounterValue,
712 profilingServicePtr,
713 armnn::profiling::INFERENCES_RUN,
714 5));
FinnWilliamsArmf6e534a2019-09-16 15:45:42 +0100715 }
FinnWilliamsArmf6e534a2019-09-16 15:45:42 +0100716 std::for_each(writers.begin(), writers.end(), mem_fn(&std::thread::join));
717
Matteo Martincigha84edee2019-10-02 12:50:57 +0100718 uint32_t counterValue = 0;
Keith Davise394bd92019-12-02 15:12:19 +0000719 BOOST_CHECK(counterValue ==
720 (profilingService.GetCounterValue(armnn::profiling::UNREGISTERED_BACKENDS)
721 - profilingService.GetCounterValue(armnn::profiling::REGISTERED_BACKENDS)));
Jan Eilersa10e2a22020-03-26 12:04:54 +0000722 BOOST_CHECK(profilingService.GetCounterValue(armnn::profiling::INFERENCES_RUN) == 50);
FinnWilliamsArmf6e534a2019-09-16 15:45:42 +0100723
Keith Davise394bd92019-12-02 15:12:19 +0000724 BOOST_CHECK_NO_THROW(profilingService.SetCounterValue(armnn::profiling::UNREGISTERED_BACKENDS, 4));
725 BOOST_CHECK_NO_THROW(counterValue = profilingService.GetCounterValue(armnn::profiling::UNREGISTERED_BACKENDS));
726 BOOST_CHECK(counterValue == 4);
Colm Donelan2ba48d22019-11-29 09:10:59 +0000727 // Reset the profiling service to stop any running thread
728 options.m_EnableProfiling = false;
729 profilingService.ResetExternalProfilingOptions(options, true);
FinnWilliamsArmf6e534a2019-09-16 15:45:42 +0100730}
731
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100732BOOST_AUTO_TEST_CASE(CheckProfilingObjectUids)
Matteo Martincighab173e92019-09-05 12:02:04 +0100733{
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100734 uint16_t uid = 0;
735 BOOST_CHECK_NO_THROW(uid = GetNextUid());
736 BOOST_CHECK(uid >= 1);
737
738 uint16_t nextUid = 0;
739 BOOST_CHECK_NO_THROW(nextUid = GetNextUid());
740 BOOST_CHECK(nextUid > uid);
741
742 std::vector<uint16_t> counterUids;
Keith Davise394bd92019-12-02 15:12:19 +0000743 BOOST_CHECK_NO_THROW(counterUids = GetNextCounterUids(uid,0));
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100744 BOOST_CHECK(counterUids.size() == 1);
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100745
746 std::vector<uint16_t> nextCounterUids;
Keith Davise394bd92019-12-02 15:12:19 +0000747 BOOST_CHECK_NO_THROW(nextCounterUids = GetNextCounterUids(nextUid, 2));
748 BOOST_CHECK(nextCounterUids.size() == 2);
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100749 BOOST_CHECK(nextCounterUids[0] > counterUids[0]);
750
751 std::vector<uint16_t> counterUidsMultiCore;
Keith Davise394bd92019-12-02 15:12:19 +0000752 uint16_t thirdUid = 4;
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100753 uint16_t numberOfCores = 13;
Keith Davise394bd92019-12-02 15:12:19 +0000754 BOOST_CHECK_NO_THROW(counterUidsMultiCore = GetNextCounterUids(thirdUid, numberOfCores));
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100755 BOOST_CHECK(counterUidsMultiCore.size() == numberOfCores);
756 BOOST_CHECK(counterUidsMultiCore.front() >= nextCounterUids[0]);
Keith Davis3201eea2019-10-24 17:30:41 +0100757 for (size_t i = 1; i < numberOfCores; i++)
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100758 {
759 BOOST_CHECK(counterUidsMultiCore[i] == counterUidsMultiCore[i - 1] + 1);
760 }
761 BOOST_CHECK(counterUidsMultiCore.back() == counterUidsMultiCore.front() + numberOfCores - 1);
Matteo Martincighab173e92019-09-05 12:02:04 +0100762}
763
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100764BOOST_AUTO_TEST_CASE(CheckCounterDirectoryRegisterCategory)
Matteo Martincighab173e92019-09-05 12:02:04 +0100765{
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100766 CounterDirectory counterDirectory;
Keith Davis3201eea2019-10-24 17:30:41 +0100767 BOOST_CHECK(counterDirectory.GetCategoryCount() == 0);
768 BOOST_CHECK(counterDirectory.GetDeviceCount() == 0);
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100769 BOOST_CHECK(counterDirectory.GetCounterSetCount() == 0);
Keith Davis3201eea2019-10-24 17:30:41 +0100770 BOOST_CHECK(counterDirectory.GetCounterCount() == 0);
Matteo Martincighab173e92019-09-05 12:02:04 +0100771
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100772 // Register a category with an invalid name
773 const Category* noCategory = nullptr;
774 BOOST_CHECK_THROW(noCategory = counterDirectory.RegisterCategory(""), armnn::InvalidArgumentException);
775 BOOST_CHECK(counterDirectory.GetCategoryCount() == 0);
776 BOOST_CHECK(!noCategory);
Matteo Martincighab173e92019-09-05 12:02:04 +0100777
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100778 // Register a category with an invalid name
779 BOOST_CHECK_THROW(noCategory = counterDirectory.RegisterCategory("invalid category"),
780 armnn::InvalidArgumentException);
781 BOOST_CHECK(counterDirectory.GetCategoryCount() == 0);
782 BOOST_CHECK(!noCategory);
783
784 // Register a new category
785 const std::string categoryName = "some_category";
Keith Davis3201eea2019-10-24 17:30:41 +0100786 const Category* category = nullptr;
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100787 BOOST_CHECK_NO_THROW(category = counterDirectory.RegisterCategory(categoryName));
788 BOOST_CHECK(counterDirectory.GetCategoryCount() == 1);
789 BOOST_CHECK(category);
790 BOOST_CHECK(category->m_Name == categoryName);
791 BOOST_CHECK(category->m_Counters.empty());
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100792
793 // Get the registered category
794 const Category* registeredCategory = counterDirectory.GetCategory(categoryName);
795 BOOST_CHECK(counterDirectory.GetCategoryCount() == 1);
796 BOOST_CHECK(registeredCategory);
797 BOOST_CHECK(registeredCategory == category);
798
799 // Try to get a category not registered
800 const Category* notRegisteredCategory = counterDirectory.GetCategory("not_registered_category");
801 BOOST_CHECK(counterDirectory.GetCategoryCount() == 1);
802 BOOST_CHECK(!notRegisteredCategory);
803
804 // Register a category already registered
805 const Category* anotherCategory = nullptr;
806 BOOST_CHECK_THROW(anotherCategory = counterDirectory.RegisterCategory(categoryName),
807 armnn::InvalidArgumentException);
808 BOOST_CHECK(counterDirectory.GetCategoryCount() == 1);
809 BOOST_CHECK(!anotherCategory);
810
811 // Register a device for testing
812 const std::string deviceName = "some_device";
Keith Davis3201eea2019-10-24 17:30:41 +0100813 const Device* device = nullptr;
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100814 BOOST_CHECK_NO_THROW(device = counterDirectory.RegisterDevice(deviceName));
815 BOOST_CHECK(counterDirectory.GetDeviceCount() == 1);
816 BOOST_CHECK(device);
817 BOOST_CHECK(device->m_Uid >= 1);
818 BOOST_CHECK(device->m_Name == deviceName);
819 BOOST_CHECK(device->m_Cores == 0);
820
821 // Register a new category not associated to any device
822 const std::string categoryWoDeviceName = "some_category_without_device";
Keith Davis3201eea2019-10-24 17:30:41 +0100823 const Category* categoryWoDevice = nullptr;
Sadik Armagan4c998992020-02-25 12:44:44 +0000824 BOOST_CHECK_NO_THROW(categoryWoDevice = counterDirectory.RegisterCategory(categoryWoDeviceName));
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100825 BOOST_CHECK(counterDirectory.GetCategoryCount() == 2);
826 BOOST_CHECK(categoryWoDevice);
827 BOOST_CHECK(categoryWoDevice->m_Name == categoryWoDeviceName);
828 BOOST_CHECK(categoryWoDevice->m_Counters.empty());
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100829
Sadik Armagan4c998992020-02-25 12:44:44 +0000830 // Register a new category associated to an invalid device name (already exist)
831 const Category* categoryInvalidDeviceName = nullptr;
832 BOOST_CHECK_THROW(categoryInvalidDeviceName =
833 counterDirectory.RegisterCategory(categoryWoDeviceName),
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100834 armnn::InvalidArgumentException);
835 BOOST_CHECK(counterDirectory.GetCategoryCount() == 2);
Sadik Armagan4c998992020-02-25 12:44:44 +0000836 BOOST_CHECK(!categoryInvalidDeviceName);
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100837
838 // Register a new category associated to a valid device
839 const std::string categoryWValidDeviceName = "some_category_with_valid_device";
Keith Davis3201eea2019-10-24 17:30:41 +0100840 const Category* categoryWValidDevice = nullptr;
841 BOOST_CHECK_NO_THROW(categoryWValidDevice =
Sadik Armagan4c998992020-02-25 12:44:44 +0000842 counterDirectory.RegisterCategory(categoryWValidDeviceName));
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100843 BOOST_CHECK(counterDirectory.GetCategoryCount() == 3);
844 BOOST_CHECK(categoryWValidDevice);
845 BOOST_CHECK(categoryWValidDevice != category);
846 BOOST_CHECK(categoryWValidDevice->m_Name == categoryWValidDeviceName);
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100847
848 // Register a counter set for testing
849 const std::string counterSetName = "some_counter_set";
Keith Davis3201eea2019-10-24 17:30:41 +0100850 const CounterSet* counterSet = nullptr;
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100851 BOOST_CHECK_NO_THROW(counterSet = counterDirectory.RegisterCounterSet(counterSetName));
852 BOOST_CHECK(counterDirectory.GetCounterSetCount() == 1);
853 BOOST_CHECK(counterSet);
854 BOOST_CHECK(counterSet->m_Uid >= 1);
855 BOOST_CHECK(counterSet->m_Name == counterSetName);
856 BOOST_CHECK(counterSet->m_Count == 0);
857
858 // Register a new category not associated to any counter set
859 const std::string categoryWoCounterSetName = "some_category_without_counter_set";
Keith Davis3201eea2019-10-24 17:30:41 +0100860 const Category* categoryWoCounterSet = nullptr;
861 BOOST_CHECK_NO_THROW(categoryWoCounterSet =
Sadik Armagan4c998992020-02-25 12:44:44 +0000862 counterDirectory.RegisterCategory(categoryWoCounterSetName));
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100863 BOOST_CHECK(counterDirectory.GetCategoryCount() == 4);
864 BOOST_CHECK(categoryWoCounterSet);
865 BOOST_CHECK(categoryWoCounterSet->m_Name == categoryWoCounterSetName);
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100866
867 // Register a new category associated to a valid counter set
868 const std::string categoryWValidCounterSetName = "some_category_with_valid_counter_set";
Keith Davis3201eea2019-10-24 17:30:41 +0100869 const Category* categoryWValidCounterSet = nullptr;
Sadik Armagan4c998992020-02-25 12:44:44 +0000870 BOOST_CHECK_NO_THROW(categoryWValidCounterSet = counterDirectory.RegisterCategory(categoryWValidCounterSetName));
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100871 BOOST_CHECK(counterDirectory.GetCategoryCount() == 5);
872 BOOST_CHECK(categoryWValidCounterSet);
873 BOOST_CHECK(categoryWValidCounterSet != category);
874 BOOST_CHECK(categoryWValidCounterSet->m_Name == categoryWValidCounterSetName);
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100875
876 // Register a new category associated to a valid device and counter set
877 const std::string categoryWValidDeviceAndValidCounterSetName = "some_category_with_valid_device_and_counter_set";
Keith Davis3201eea2019-10-24 17:30:41 +0100878 const Category* categoryWValidDeviceAndValidCounterSet = nullptr;
879 BOOST_CHECK_NO_THROW(categoryWValidDeviceAndValidCounterSet = counterDirectory.RegisterCategory(
Sadik Armagan4c998992020-02-25 12:44:44 +0000880 categoryWValidDeviceAndValidCounterSetName));
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100881 BOOST_CHECK(counterDirectory.GetCategoryCount() == 6);
882 BOOST_CHECK(categoryWValidDeviceAndValidCounterSet);
883 BOOST_CHECK(categoryWValidDeviceAndValidCounterSet != category);
884 BOOST_CHECK(categoryWValidDeviceAndValidCounterSet->m_Name == categoryWValidDeviceAndValidCounterSetName);
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100885}
886
887BOOST_AUTO_TEST_CASE(CheckCounterDirectoryRegisterDevice)
888{
889 CounterDirectory counterDirectory;
Keith Davis3201eea2019-10-24 17:30:41 +0100890 BOOST_CHECK(counterDirectory.GetCategoryCount() == 0);
891 BOOST_CHECK(counterDirectory.GetDeviceCount() == 0);
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100892 BOOST_CHECK(counterDirectory.GetCounterSetCount() == 0);
Keith Davis3201eea2019-10-24 17:30:41 +0100893 BOOST_CHECK(counterDirectory.GetCounterCount() == 0);
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100894
895 // Register a device with an invalid name
896 const Device* noDevice = nullptr;
897 BOOST_CHECK_THROW(noDevice = counterDirectory.RegisterDevice(""), armnn::InvalidArgumentException);
898 BOOST_CHECK(counterDirectory.GetDeviceCount() == 0);
899 BOOST_CHECK(!noDevice);
900
901 // Register a device with an invalid name
902 BOOST_CHECK_THROW(noDevice = counterDirectory.RegisterDevice("inv@lid nam€"), armnn::InvalidArgumentException);
903 BOOST_CHECK(counterDirectory.GetDeviceCount() == 0);
904 BOOST_CHECK(!noDevice);
905
906 // Register a new device with no cores or parent category
907 const std::string deviceName = "some_device";
Keith Davis3201eea2019-10-24 17:30:41 +0100908 const Device* device = nullptr;
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100909 BOOST_CHECK_NO_THROW(device = counterDirectory.RegisterDevice(deviceName));
910 BOOST_CHECK(counterDirectory.GetDeviceCount() == 1);
911 BOOST_CHECK(device);
912 BOOST_CHECK(device->m_Name == deviceName);
913 BOOST_CHECK(device->m_Uid >= 1);
914 BOOST_CHECK(device->m_Cores == 0);
915
Matteo Martincigh657ab2d2019-09-18 10:53:24 +0100916 // Try getting an unregistered device
917 const Device* unregisteredDevice = counterDirectory.GetDevice(9999);
918 BOOST_CHECK(!unregisteredDevice);
919
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100920 // Get the registered device
921 const Device* registeredDevice = counterDirectory.GetDevice(device->m_Uid);
922 BOOST_CHECK(counterDirectory.GetDeviceCount() == 1);
923 BOOST_CHECK(registeredDevice);
924 BOOST_CHECK(registeredDevice == device);
925
Matteo Martincigh657ab2d2019-09-18 10:53:24 +0100926 // Register a device with the name of a device already registered
927 const Device* deviceSameName = nullptr;
928 BOOST_CHECK_THROW(deviceSameName = counterDirectory.RegisterDevice(deviceName), armnn::InvalidArgumentException);
929 BOOST_CHECK(counterDirectory.GetDeviceCount() == 1);
930 BOOST_CHECK(!deviceSameName);
931
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100932 // Register a new device with cores and no parent category
933 const std::string deviceWCoresName = "some_device_with_cores";
Keith Davis3201eea2019-10-24 17:30:41 +0100934 const Device* deviceWCores = nullptr;
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100935 BOOST_CHECK_NO_THROW(deviceWCores = counterDirectory.RegisterDevice(deviceWCoresName, 2));
936 BOOST_CHECK(counterDirectory.GetDeviceCount() == 2);
937 BOOST_CHECK(deviceWCores);
938 BOOST_CHECK(deviceWCores->m_Name == deviceWCoresName);
939 BOOST_CHECK(deviceWCores->m_Uid >= 1);
940 BOOST_CHECK(deviceWCores->m_Uid > device->m_Uid);
941 BOOST_CHECK(deviceWCores->m_Cores == 2);
942
943 // Get the registered device
944 const Device* registeredDeviceWCores = counterDirectory.GetDevice(deviceWCores->m_Uid);
945 BOOST_CHECK(counterDirectory.GetDeviceCount() == 2);
946 BOOST_CHECK(registeredDeviceWCores);
947 BOOST_CHECK(registeredDeviceWCores == deviceWCores);
948 BOOST_CHECK(registeredDeviceWCores != device);
949
950 // Register a new device with cores and invalid parent category
951 const std::string deviceWCoresWInvalidParentCategoryName = "some_device_with_cores_with_invalid_parent_category";
Keith Davis3201eea2019-10-24 17:30:41 +0100952 const Device* deviceWCoresWInvalidParentCategory = nullptr;
953 BOOST_CHECK_THROW(deviceWCoresWInvalidParentCategory =
954 counterDirectory.RegisterDevice(deviceWCoresWInvalidParentCategoryName, 3, std::string("")),
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100955 armnn::InvalidArgumentException);
956 BOOST_CHECK(counterDirectory.GetDeviceCount() == 2);
957 BOOST_CHECK(!deviceWCoresWInvalidParentCategory);
958
959 // Register a new device with cores and invalid parent category
960 const std::string deviceWCoresWInvalidParentCategoryName2 = "some_device_with_cores_with_invalid_parent_category2";
Keith Davis3201eea2019-10-24 17:30:41 +0100961 const Device* deviceWCoresWInvalidParentCategory2 = nullptr;
962 BOOST_CHECK_THROW(deviceWCoresWInvalidParentCategory2 = counterDirectory.RegisterDevice(
963 deviceWCoresWInvalidParentCategoryName2, 3, std::string("invalid_parent_category")),
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100964 armnn::InvalidArgumentException);
965 BOOST_CHECK(counterDirectory.GetDeviceCount() == 2);
966 BOOST_CHECK(!deviceWCoresWInvalidParentCategory2);
967
968 // Register a category for testing
969 const std::string categoryName = "some_category";
Keith Davis3201eea2019-10-24 17:30:41 +0100970 const Category* category = nullptr;
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100971 BOOST_CHECK_NO_THROW(category = counterDirectory.RegisterCategory(categoryName));
972 BOOST_CHECK(counterDirectory.GetCategoryCount() == 1);
973 BOOST_CHECK(category);
974 BOOST_CHECK(category->m_Name == categoryName);
975 BOOST_CHECK(category->m_Counters.empty());
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100976
977 // Register a new device with cores and valid parent category
978 const std::string deviceWCoresWValidParentCategoryName = "some_device_with_cores_with_valid_parent_category";
Keith Davis3201eea2019-10-24 17:30:41 +0100979 const Device* deviceWCoresWValidParentCategory = nullptr;
980 BOOST_CHECK_NO_THROW(deviceWCoresWValidParentCategory =
981 counterDirectory.RegisterDevice(deviceWCoresWValidParentCategoryName, 4, categoryName));
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100982 BOOST_CHECK(counterDirectory.GetDeviceCount() == 3);
983 BOOST_CHECK(deviceWCoresWValidParentCategory);
984 BOOST_CHECK(deviceWCoresWValidParentCategory->m_Name == deviceWCoresWValidParentCategoryName);
985 BOOST_CHECK(deviceWCoresWValidParentCategory->m_Uid >= 1);
986 BOOST_CHECK(deviceWCoresWValidParentCategory->m_Uid > device->m_Uid);
987 BOOST_CHECK(deviceWCoresWValidParentCategory->m_Uid > deviceWCores->m_Uid);
988 BOOST_CHECK(deviceWCoresWValidParentCategory->m_Cores == 4);
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100989}
990
991BOOST_AUTO_TEST_CASE(CheckCounterDirectoryRegisterCounterSet)
992{
993 CounterDirectory counterDirectory;
Keith Davis3201eea2019-10-24 17:30:41 +0100994 BOOST_CHECK(counterDirectory.GetCategoryCount() == 0);
995 BOOST_CHECK(counterDirectory.GetDeviceCount() == 0);
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100996 BOOST_CHECK(counterDirectory.GetCounterSetCount() == 0);
Keith Davis3201eea2019-10-24 17:30:41 +0100997 BOOST_CHECK(counterDirectory.GetCounterCount() == 0);
Matteo Martincigh6db5f202019-09-05 12:02:04 +0100998
999 // Register a counter set with an invalid name
1000 const CounterSet* noCounterSet = nullptr;
1001 BOOST_CHECK_THROW(noCounterSet = counterDirectory.RegisterCounterSet(""), armnn::InvalidArgumentException);
1002 BOOST_CHECK(counterDirectory.GetCounterSetCount() == 0);
1003 BOOST_CHECK(!noCounterSet);
1004
1005 // Register a counter set with an invalid name
1006 BOOST_CHECK_THROW(noCounterSet = counterDirectory.RegisterCounterSet("invalid name"),
1007 armnn::InvalidArgumentException);
1008 BOOST_CHECK(counterDirectory.GetCounterSetCount() == 0);
1009 BOOST_CHECK(!noCounterSet);
1010
1011 // Register a new counter set with no count or parent category
1012 const std::string counterSetName = "some_counter_set";
Keith Davis3201eea2019-10-24 17:30:41 +01001013 const CounterSet* counterSet = nullptr;
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001014 BOOST_CHECK_NO_THROW(counterSet = counterDirectory.RegisterCounterSet(counterSetName));
1015 BOOST_CHECK(counterDirectory.GetCounterSetCount() == 1);
1016 BOOST_CHECK(counterSet);
1017 BOOST_CHECK(counterSet->m_Name == counterSetName);
1018 BOOST_CHECK(counterSet->m_Uid >= 1);
1019 BOOST_CHECK(counterSet->m_Count == 0);
1020
Matteo Martincigh657ab2d2019-09-18 10:53:24 +01001021 // Try getting an unregistered counter set
1022 const CounterSet* unregisteredCounterSet = counterDirectory.GetCounterSet(9999);
1023 BOOST_CHECK(!unregisteredCounterSet);
1024
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001025 // Get the registered counter set
1026 const CounterSet* registeredCounterSet = counterDirectory.GetCounterSet(counterSet->m_Uid);
1027 BOOST_CHECK(counterDirectory.GetCounterSetCount() == 1);
1028 BOOST_CHECK(registeredCounterSet);
1029 BOOST_CHECK(registeredCounterSet == counterSet);
1030
Matteo Martincigh657ab2d2019-09-18 10:53:24 +01001031 // Register a counter set with the name of a counter set already registered
1032 const CounterSet* counterSetSameName = nullptr;
1033 BOOST_CHECK_THROW(counterSetSameName = counterDirectory.RegisterCounterSet(counterSetName),
1034 armnn::InvalidArgumentException);
1035 BOOST_CHECK(counterDirectory.GetCounterSetCount() == 1);
1036 BOOST_CHECK(!counterSetSameName);
1037
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001038 // Register a new counter set with count and no parent category
1039 const std::string counterSetWCountName = "some_counter_set_with_count";
Keith Davis3201eea2019-10-24 17:30:41 +01001040 const CounterSet* counterSetWCount = nullptr;
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001041 BOOST_CHECK_NO_THROW(counterSetWCount = counterDirectory.RegisterCounterSet(counterSetWCountName, 37));
1042 BOOST_CHECK(counterDirectory.GetCounterSetCount() == 2);
1043 BOOST_CHECK(counterSetWCount);
1044 BOOST_CHECK(counterSetWCount->m_Name == counterSetWCountName);
1045 BOOST_CHECK(counterSetWCount->m_Uid >= 1);
1046 BOOST_CHECK(counterSetWCount->m_Uid > counterSet->m_Uid);
1047 BOOST_CHECK(counterSetWCount->m_Count == 37);
1048
1049 // Get the registered counter set
1050 const CounterSet* registeredCounterSetWCount = counterDirectory.GetCounterSet(counterSetWCount->m_Uid);
1051 BOOST_CHECK(counterDirectory.GetCounterSetCount() == 2);
1052 BOOST_CHECK(registeredCounterSetWCount);
1053 BOOST_CHECK(registeredCounterSetWCount == counterSetWCount);
1054 BOOST_CHECK(registeredCounterSetWCount != counterSet);
1055
1056 // Register a new counter set with count and invalid parent category
1057 const std::string counterSetWCountWInvalidParentCategoryName = "some_counter_set_with_count_"
1058 "with_invalid_parent_category";
1059 const CounterSet* counterSetWCountWInvalidParentCategory = nullptr;
Keith Davis3201eea2019-10-24 17:30:41 +01001060 BOOST_CHECK_THROW(counterSetWCountWInvalidParentCategory = counterDirectory.RegisterCounterSet(
1061 counterSetWCountWInvalidParentCategoryName, 42, std::string("")),
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001062 armnn::InvalidArgumentException);
1063 BOOST_CHECK(counterDirectory.GetCounterSetCount() == 2);
1064 BOOST_CHECK(!counterSetWCountWInvalidParentCategory);
1065
1066 // Register a new counter set with count and invalid parent category
1067 const std::string counterSetWCountWInvalidParentCategoryName2 = "some_counter_set_with_count_"
1068 "with_invalid_parent_category2";
1069 const CounterSet* counterSetWCountWInvalidParentCategory2 = nullptr;
Keith Davis3201eea2019-10-24 17:30:41 +01001070 BOOST_CHECK_THROW(counterSetWCountWInvalidParentCategory2 = counterDirectory.RegisterCounterSet(
1071 counterSetWCountWInvalidParentCategoryName2, 42, std::string("invalid_parent_category")),
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001072 armnn::InvalidArgumentException);
1073 BOOST_CHECK(counterDirectory.GetCounterSetCount() == 2);
1074 BOOST_CHECK(!counterSetWCountWInvalidParentCategory2);
1075
1076 // Register a category for testing
1077 const std::string categoryName = "some_category";
Keith Davis3201eea2019-10-24 17:30:41 +01001078 const Category* category = nullptr;
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001079 BOOST_CHECK_NO_THROW(category = counterDirectory.RegisterCategory(categoryName));
1080 BOOST_CHECK(counterDirectory.GetCategoryCount() == 1);
1081 BOOST_CHECK(category);
1082 BOOST_CHECK(category->m_Name == categoryName);
1083 BOOST_CHECK(category->m_Counters.empty());
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001084
1085 // Register a new counter set with count and valid parent category
1086 const std::string counterSetWCountWValidParentCategoryName = "some_counter_set_with_count_"
1087 "with_valid_parent_category";
1088 const CounterSet* counterSetWCountWValidParentCategory = nullptr;
Keith Davis3201eea2019-10-24 17:30:41 +01001089 BOOST_CHECK_NO_THROW(counterSetWCountWValidParentCategory = counterDirectory.RegisterCounterSet(
1090 counterSetWCountWValidParentCategoryName, 42, categoryName));
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001091 BOOST_CHECK(counterDirectory.GetCounterSetCount() == 3);
1092 BOOST_CHECK(counterSetWCountWValidParentCategory);
1093 BOOST_CHECK(counterSetWCountWValidParentCategory->m_Name == counterSetWCountWValidParentCategoryName);
1094 BOOST_CHECK(counterSetWCountWValidParentCategory->m_Uid >= 1);
1095 BOOST_CHECK(counterSetWCountWValidParentCategory->m_Uid > counterSet->m_Uid);
1096 BOOST_CHECK(counterSetWCountWValidParentCategory->m_Uid > counterSetWCount->m_Uid);
1097 BOOST_CHECK(counterSetWCountWValidParentCategory->m_Count == 42);
Matteo Martincigh657ab2d2019-09-18 10:53:24 +01001098
Sadik Armagan4c998992020-02-25 12:44:44 +00001099 // Register a counter set associated to a category with invalid name
Matteo Martincigh657ab2d2019-09-18 10:53:24 +01001100 const std::string counterSetSameCategoryName = "some_counter_set_with_invalid_parent_category";
Sadik Armagan4c998992020-02-25 12:44:44 +00001101 const std::string invalidCategoryName = "";
Keith Davis3201eea2019-10-24 17:30:41 +01001102 const CounterSet* counterSetSameCategory = nullptr;
1103 BOOST_CHECK_THROW(counterSetSameCategory =
Sadik Armagan4c998992020-02-25 12:44:44 +00001104 counterDirectory.RegisterCounterSet(counterSetSameCategoryName, 0, invalidCategoryName),
Matteo Martincigh657ab2d2019-09-18 10:53:24 +01001105 armnn::InvalidArgumentException);
1106 BOOST_CHECK(counterDirectory.GetCounterSetCount() == 3);
1107 BOOST_CHECK(!counterSetSameCategory);
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001108}
1109
1110BOOST_AUTO_TEST_CASE(CheckCounterDirectoryRegisterCounter)
1111{
1112 CounterDirectory counterDirectory;
Keith Davis3201eea2019-10-24 17:30:41 +01001113 BOOST_CHECK(counterDirectory.GetCategoryCount() == 0);
1114 BOOST_CHECK(counterDirectory.GetDeviceCount() == 0);
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001115 BOOST_CHECK(counterDirectory.GetCounterSetCount() == 0);
Keith Davis3201eea2019-10-24 17:30:41 +01001116 BOOST_CHECK(counterDirectory.GetCounterCount() == 0);
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001117
1118 // Register a counter with an invalid parent category name
1119 const Counter* noCounter = nullptr;
Keith Davis3201eea2019-10-24 17:30:41 +01001120 BOOST_CHECK_THROW(noCounter =
Keith Davise394bd92019-12-02 15:12:19 +00001121 counterDirectory.RegisterCounter(armnn::profiling::BACKEND_ID,
1122 0,
1123 "",
1124 0,
1125 1,
1126 123.45f,
1127 "valid ",
1128 "name"),
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001129 armnn::InvalidArgumentException);
1130 BOOST_CHECK(counterDirectory.GetCounterCount() == 0);
1131 BOOST_CHECK(!noCounter);
1132
1133 // Register a counter with an invalid parent category name
Keith Davise394bd92019-12-02 15:12:19 +00001134 BOOST_CHECK_THROW(noCounter = counterDirectory.RegisterCounter(armnn::profiling::BACKEND_ID,
1135 1,
1136 "invalid parent category",
1137 0,
1138 1,
1139 123.45f,
1140 "valid name",
1141 "valid description"),
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001142 armnn::InvalidArgumentException);
1143 BOOST_CHECK(counterDirectory.GetCounterCount() == 0);
1144 BOOST_CHECK(!noCounter);
1145
1146 // Register a counter with an invalid class
Keith Davise394bd92019-12-02 15:12:19 +00001147 BOOST_CHECK_THROW(noCounter = counterDirectory.RegisterCounter(armnn::profiling::BACKEND_ID,
1148 2,
1149 "valid_parent_category",
1150 2,
1151 1,
1152 123.45f,
1153 "valid "
1154 "name",
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001155 "valid description"),
1156 armnn::InvalidArgumentException);
1157 BOOST_CHECK(counterDirectory.GetCounterCount() == 0);
1158 BOOST_CHECK(!noCounter);
1159
1160 // Register a counter with an invalid interpolation
Keith Davise394bd92019-12-02 15:12:19 +00001161 BOOST_CHECK_THROW(noCounter = counterDirectory.RegisterCounter(armnn::profiling::BACKEND_ID,
1162 4,
1163 "valid_parent_category",
1164 0,
1165 3,
1166 123.45f,
1167 "valid "
1168 "name",
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001169 "valid description"),
1170 armnn::InvalidArgumentException);
1171 BOOST_CHECK(counterDirectory.GetCounterCount() == 0);
1172 BOOST_CHECK(!noCounter);
1173
1174 // Register a counter with an invalid multiplier
Keith Davise394bd92019-12-02 15:12:19 +00001175 BOOST_CHECK_THROW(noCounter = counterDirectory.RegisterCounter(armnn::profiling::BACKEND_ID,
1176 5,
1177 "valid_parent_category",
1178 0,
1179 1,
1180 .0f,
1181 "valid "
1182 "name",
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001183 "valid description"),
1184 armnn::InvalidArgumentException);
1185 BOOST_CHECK(counterDirectory.GetCounterCount() == 0);
1186 BOOST_CHECK(!noCounter);
1187
1188 // Register a counter with an invalid name
Keith Davis3201eea2019-10-24 17:30:41 +01001189 BOOST_CHECK_THROW(
Keith Davise394bd92019-12-02 15:12:19 +00001190 noCounter = counterDirectory.RegisterCounter(armnn::profiling::BACKEND_ID,
1191 6,
1192 "valid_parent_category",
1193 0,
1194 1,
1195 123.45f,
1196 "",
1197 "valid description"),
Keith Davis3201eea2019-10-24 17:30:41 +01001198 armnn::InvalidArgumentException);
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001199 BOOST_CHECK(counterDirectory.GetCounterCount() == 0);
1200 BOOST_CHECK(!noCounter);
1201
1202 // Register a counter with an invalid name
Keith Davise394bd92019-12-02 15:12:19 +00001203 BOOST_CHECK_THROW(noCounter = counterDirectory.RegisterCounter(armnn::profiling::BACKEND_ID,
1204 7,
1205 "valid_parent_category",
1206 0,
1207 1,
1208 123.45f,
1209 "invalid nam€",
1210 "valid description"),
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001211 armnn::InvalidArgumentException);
1212 BOOST_CHECK(counterDirectory.GetCounterCount() == 0);
1213 BOOST_CHECK(!noCounter);
1214
1215 // Register a counter with an invalid description
Keith Davis3201eea2019-10-24 17:30:41 +01001216 BOOST_CHECK_THROW(noCounter =
Keith Davise394bd92019-12-02 15:12:19 +00001217 counterDirectory.RegisterCounter(armnn::profiling::BACKEND_ID,
1218 8,
1219 "valid_parent_category",
1220 0,
1221 1,
1222 123.45f,
1223 "valid name",
1224 ""),
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001225 armnn::InvalidArgumentException);
1226 BOOST_CHECK(counterDirectory.GetCounterCount() == 0);
1227 BOOST_CHECK(!noCounter);
1228
1229 // Register a counter with an invalid description
Keith Davise394bd92019-12-02 15:12:19 +00001230 BOOST_CHECK_THROW(noCounter = counterDirectory.RegisterCounter(armnn::profiling::BACKEND_ID,
1231 9,
1232 "valid_parent_category",
1233 0,
1234 1,
1235 123.45f,
1236 "valid "
1237 "name",
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001238 "inv@lid description"),
1239 armnn::InvalidArgumentException);
1240 BOOST_CHECK(counterDirectory.GetCounterCount() == 0);
1241 BOOST_CHECK(!noCounter);
1242
1243 // Register a counter with an invalid unit2
Keith Davise394bd92019-12-02 15:12:19 +00001244 BOOST_CHECK_THROW(noCounter = counterDirectory.RegisterCounter(armnn::profiling::BACKEND_ID,
1245 10,
1246 "valid_parent_category",
1247 0,
1248 1,
1249 123.45f,
1250 "valid name",
1251 "valid description",
1252 std::string("Mb/s2")),
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001253 armnn::InvalidArgumentException);
1254 BOOST_CHECK(counterDirectory.GetCounterCount() == 0);
1255 BOOST_CHECK(!noCounter);
1256
1257 // Register a counter with a non-existing parent category name
Keith Davise394bd92019-12-02 15:12:19 +00001258 BOOST_CHECK_THROW(noCounter = counterDirectory.RegisterCounter(armnn::profiling::BACKEND_ID,
1259 11,
1260 "invalid_parent_category",
1261 0,
1262 1,
1263 123.45f,
1264 "valid name",
1265 "valid description"),
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001266 armnn::InvalidArgumentException);
1267 BOOST_CHECK(counterDirectory.GetCounterCount() == 0);
1268 BOOST_CHECK(!noCounter);
1269
Matteo Martincigh657ab2d2019-09-18 10:53:24 +01001270 // Try getting an unregistered counter
1271 const Counter* unregisteredCounter = counterDirectory.GetCounter(9999);
1272 BOOST_CHECK(!unregisteredCounter);
1273
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001274 // Register a category for testing
1275 const std::string categoryName = "some_category";
Keith Davis3201eea2019-10-24 17:30:41 +01001276 const Category* category = nullptr;
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001277 BOOST_CHECK_NO_THROW(category = counterDirectory.RegisterCategory(categoryName));
1278 BOOST_CHECK(counterDirectory.GetCategoryCount() == 1);
1279 BOOST_CHECK(category);
1280 BOOST_CHECK(category->m_Name == categoryName);
1281 BOOST_CHECK(category->m_Counters.empty());
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001282
1283 // Register a counter with a valid parent category name
1284 const Counter* counter = nullptr;
Keith Davis3201eea2019-10-24 17:30:41 +01001285 BOOST_CHECK_NO_THROW(
Keith Davise394bd92019-12-02 15:12:19 +00001286 counter = counterDirectory.RegisterCounter(armnn::profiling::BACKEND_ID,
1287 12,
1288 categoryName,
1289 0,
1290 1,
1291 123.45f,
1292 "valid name",
1293 "valid description"));
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001294 BOOST_CHECK(counterDirectory.GetCounterCount() == 1);
1295 BOOST_CHECK(counter);
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001296 BOOST_CHECK(counter->m_MaxCounterUid == counter->m_Uid);
1297 BOOST_CHECK(counter->m_Class == 0);
1298 BOOST_CHECK(counter->m_Interpolation == 1);
1299 BOOST_CHECK(counter->m_Multiplier == 123.45f);
1300 BOOST_CHECK(counter->m_Name == "valid name");
1301 BOOST_CHECK(counter->m_Description == "valid description");
1302 BOOST_CHECK(counter->m_Units == "");
1303 BOOST_CHECK(counter->m_DeviceUid == 0);
1304 BOOST_CHECK(counter->m_CounterSetUid == 0);
1305 BOOST_CHECK(category->m_Counters.size() == 1);
1306 BOOST_CHECK(category->m_Counters.back() == counter->m_Uid);
1307
Matteo Martincigh657ab2d2019-09-18 10:53:24 +01001308 // Register a counter with a name of a counter already registered for the given parent category name
1309 const Counter* counterSameName = nullptr;
Keith Davis3201eea2019-10-24 17:30:41 +01001310 BOOST_CHECK_THROW(counterSameName =
Keith Davise394bd92019-12-02 15:12:19 +00001311 counterDirectory.RegisterCounter(armnn::profiling::BACKEND_ID,
1312 13,
1313 categoryName,
1314 0,
1315 0,
1316 1.0f,
1317 "valid name",
1318 "valid description",
1319 std::string("description")),
Matteo Martincigh657ab2d2019-09-18 10:53:24 +01001320 armnn::InvalidArgumentException);
1321 BOOST_CHECK(counterDirectory.GetCounterCount() == 1);
1322 BOOST_CHECK(!counterSameName);
1323
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001324 // Register a counter with a valid parent category name and units
1325 const Counter* counterWUnits = nullptr;
Keith Davise394bd92019-12-02 15:12:19 +00001326 BOOST_CHECK_NO_THROW(counterWUnits = counterDirectory.RegisterCounter(armnn::profiling::BACKEND_ID,
1327 14,
1328 categoryName,
1329 0,
1330 1,
1331 123.45f,
1332 "valid name 2",
1333 "valid description",
1334 std::string("Mnnsq2"))); // Units
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001335 BOOST_CHECK(counterDirectory.GetCounterCount() == 2);
1336 BOOST_CHECK(counterWUnits);
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001337 BOOST_CHECK(counterWUnits->m_Uid > counter->m_Uid);
1338 BOOST_CHECK(counterWUnits->m_MaxCounterUid == counterWUnits->m_Uid);
1339 BOOST_CHECK(counterWUnits->m_Class == 0);
1340 BOOST_CHECK(counterWUnits->m_Interpolation == 1);
1341 BOOST_CHECK(counterWUnits->m_Multiplier == 123.45f);
1342 BOOST_CHECK(counterWUnits->m_Name == "valid name 2");
1343 BOOST_CHECK(counterWUnits->m_Description == "valid description");
1344 BOOST_CHECK(counterWUnits->m_Units == "Mnnsq2");
1345 BOOST_CHECK(counterWUnits->m_DeviceUid == 0);
1346 BOOST_CHECK(counterWUnits->m_CounterSetUid == 0);
1347 BOOST_CHECK(category->m_Counters.size() == 2);
1348 BOOST_CHECK(category->m_Counters.back() == counterWUnits->m_Uid);
1349
1350 // Register a counter with a valid parent category name and not associated with a device
1351 const Counter* counterWoDevice = nullptr;
Keith Davise394bd92019-12-02 15:12:19 +00001352 BOOST_CHECK_NO_THROW(counterWoDevice = counterDirectory.RegisterCounter(armnn::profiling::BACKEND_ID,
1353 26,
1354 categoryName,
1355 0,
1356 1,
1357 123.45f,
1358 "valid name 3",
1359 "valid description",
1360 armnn::EmptyOptional(),// Units
1361 armnn::EmptyOptional(),// Number of cores
1362 0)); // Device UID
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001363 BOOST_CHECK(counterDirectory.GetCounterCount() == 3);
1364 BOOST_CHECK(counterWoDevice);
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001365 BOOST_CHECK(counterWoDevice->m_Uid > counter->m_Uid);
1366 BOOST_CHECK(counterWoDevice->m_MaxCounterUid == counterWoDevice->m_Uid);
1367 BOOST_CHECK(counterWoDevice->m_Class == 0);
1368 BOOST_CHECK(counterWoDevice->m_Interpolation == 1);
1369 BOOST_CHECK(counterWoDevice->m_Multiplier == 123.45f);
1370 BOOST_CHECK(counterWoDevice->m_Name == "valid name 3");
1371 BOOST_CHECK(counterWoDevice->m_Description == "valid description");
1372 BOOST_CHECK(counterWoDevice->m_Units == "");
1373 BOOST_CHECK(counterWoDevice->m_DeviceUid == 0);
1374 BOOST_CHECK(counterWoDevice->m_CounterSetUid == 0);
1375 BOOST_CHECK(category->m_Counters.size() == 3);
1376 BOOST_CHECK(category->m_Counters.back() == counterWoDevice->m_Uid);
1377
1378 // Register a counter with a valid parent category name and associated to an invalid device
Keith Davise394bd92019-12-02 15:12:19 +00001379 BOOST_CHECK_THROW(noCounter = counterDirectory.RegisterCounter(armnn::profiling::BACKEND_ID,
1380 15,
1381 categoryName,
1382 0,
1383 1,
1384 123.45f,
1385 "valid name 4",
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001386 "valid description",
Keith Davis3201eea2019-10-24 17:30:41 +01001387 armnn::EmptyOptional(), // Units
1388 armnn::EmptyOptional(), // Number of cores
1389 100), // Device UID
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001390 armnn::InvalidArgumentException);
1391 BOOST_CHECK(counterDirectory.GetCounterCount() == 3);
1392 BOOST_CHECK(!noCounter);
1393
1394 // Register a device for testing
1395 const std::string deviceName = "some_device";
Keith Davis3201eea2019-10-24 17:30:41 +01001396 const Device* device = nullptr;
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001397 BOOST_CHECK_NO_THROW(device = counterDirectory.RegisterDevice(deviceName));
1398 BOOST_CHECK(counterDirectory.GetDeviceCount() == 1);
1399 BOOST_CHECK(device);
1400 BOOST_CHECK(device->m_Name == deviceName);
1401 BOOST_CHECK(device->m_Uid >= 1);
1402 BOOST_CHECK(device->m_Cores == 0);
1403
1404 // Register a counter with a valid parent category name and associated to a device
1405 const Counter* counterWDevice = nullptr;
Keith Davise394bd92019-12-02 15:12:19 +00001406 BOOST_CHECK_NO_THROW(counterWDevice = counterDirectory.RegisterCounter(armnn::profiling::BACKEND_ID,
1407 16,
1408 categoryName,
1409 0,
1410 1,
1411 123.45f,
1412 "valid name 5",
1413 std::string("valid description"),
Keith Davis3201eea2019-10-24 17:30:41 +01001414 armnn::EmptyOptional(), // Units
1415 armnn::EmptyOptional(), // Number of cores
1416 device->m_Uid)); // Device UID
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001417 BOOST_CHECK(counterDirectory.GetCounterCount() == 4);
1418 BOOST_CHECK(counterWDevice);
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001419 BOOST_CHECK(counterWDevice->m_Uid > counter->m_Uid);
1420 BOOST_CHECK(counterWDevice->m_MaxCounterUid == counterWDevice->m_Uid);
1421 BOOST_CHECK(counterWDevice->m_Class == 0);
1422 BOOST_CHECK(counterWDevice->m_Interpolation == 1);
1423 BOOST_CHECK(counterWDevice->m_Multiplier == 123.45f);
1424 BOOST_CHECK(counterWDevice->m_Name == "valid name 5");
1425 BOOST_CHECK(counterWDevice->m_Description == "valid description");
1426 BOOST_CHECK(counterWDevice->m_Units == "");
1427 BOOST_CHECK(counterWDevice->m_DeviceUid == device->m_Uid);
1428 BOOST_CHECK(counterWDevice->m_CounterSetUid == 0);
1429 BOOST_CHECK(category->m_Counters.size() == 4);
1430 BOOST_CHECK(category->m_Counters.back() == counterWDevice->m_Uid);
1431
1432 // Register a counter with a valid parent category name and not associated with a counter set
1433 const Counter* counterWoCounterSet = nullptr;
Keith Davise394bd92019-12-02 15:12:19 +00001434 BOOST_CHECK_NO_THROW(counterWoCounterSet = counterDirectory.RegisterCounter(armnn::profiling::BACKEND_ID,
1435 17,
1436 categoryName,
1437 0,
1438 1,
1439 123.45f,
1440 "valid name 6",
1441 "valid description",
1442 armnn::EmptyOptional(),// Units
1443 armnn::EmptyOptional(),// No of cores
1444 armnn::EmptyOptional(),// Device UID
1445 0)); // CounterSet UID
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001446 BOOST_CHECK(counterDirectory.GetCounterCount() == 5);
1447 BOOST_CHECK(counterWoCounterSet);
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001448 BOOST_CHECK(counterWoCounterSet->m_Uid > counter->m_Uid);
1449 BOOST_CHECK(counterWoCounterSet->m_MaxCounterUid == counterWoCounterSet->m_Uid);
1450 BOOST_CHECK(counterWoCounterSet->m_Class == 0);
1451 BOOST_CHECK(counterWoCounterSet->m_Interpolation == 1);
1452 BOOST_CHECK(counterWoCounterSet->m_Multiplier == 123.45f);
1453 BOOST_CHECK(counterWoCounterSet->m_Name == "valid name 6");
1454 BOOST_CHECK(counterWoCounterSet->m_Description == "valid description");
1455 BOOST_CHECK(counterWoCounterSet->m_Units == "");
1456 BOOST_CHECK(counterWoCounterSet->m_DeviceUid == 0);
1457 BOOST_CHECK(counterWoCounterSet->m_CounterSetUid == 0);
1458 BOOST_CHECK(category->m_Counters.size() == 5);
1459 BOOST_CHECK(category->m_Counters.back() == counterWoCounterSet->m_Uid);
1460
1461 // Register a counter with a valid parent category name and associated to an invalid counter set
Keith Davise394bd92019-12-02 15:12:19 +00001462 BOOST_CHECK_THROW(noCounter = counterDirectory.RegisterCounter(armnn::profiling::BACKEND_ID,
1463 18,
1464 categoryName,
1465 0,
1466 1,
1467 123.45f,
1468 "valid ",
1469 "name 7",
1470 std::string("valid description"),
Keith Davis3201eea2019-10-24 17:30:41 +01001471 armnn::EmptyOptional(), // Units
1472 armnn::EmptyOptional(), // Number of cores
Keith Davise394bd92019-12-02 15:12:19 +00001473 100), // Counter set UID
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001474 armnn::InvalidArgumentException);
1475 BOOST_CHECK(counterDirectory.GetCounterCount() == 5);
1476 BOOST_CHECK(!noCounter);
1477
1478 // Register a counter with a valid parent category name and with a given number of cores
1479 const Counter* counterWNumberOfCores = nullptr;
Keith Davis3201eea2019-10-24 17:30:41 +01001480 uint16_t numberOfCores = 15;
1481 BOOST_CHECK_NO_THROW(counterWNumberOfCores = counterDirectory.RegisterCounter(
Keith Davise394bd92019-12-02 15:12:19 +00001482 armnn::profiling::BACKEND_ID, 50,
Keith Davis3201eea2019-10-24 17:30:41 +01001483 categoryName, 0, 1, 123.45f, "valid name 8", "valid description",
1484 armnn::EmptyOptional(), // Units
1485 numberOfCores, // Number of cores
1486 armnn::EmptyOptional(), // Device UID
1487 armnn::EmptyOptional())); // Counter set UID
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001488 BOOST_CHECK(counterDirectory.GetCounterCount() == 20);
1489 BOOST_CHECK(counterWNumberOfCores);
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001490 BOOST_CHECK(counterWNumberOfCores->m_Uid > counter->m_Uid);
1491 BOOST_CHECK(counterWNumberOfCores->m_MaxCounterUid == counterWNumberOfCores->m_Uid + numberOfCores - 1);
1492 BOOST_CHECK(counterWNumberOfCores->m_Class == 0);
1493 BOOST_CHECK(counterWNumberOfCores->m_Interpolation == 1);
1494 BOOST_CHECK(counterWNumberOfCores->m_Multiplier == 123.45f);
1495 BOOST_CHECK(counterWNumberOfCores->m_Name == "valid name 8");
1496 BOOST_CHECK(counterWNumberOfCores->m_Description == "valid description");
1497 BOOST_CHECK(counterWNumberOfCores->m_Units == "");
1498 BOOST_CHECK(counterWNumberOfCores->m_DeviceUid == 0);
1499 BOOST_CHECK(counterWNumberOfCores->m_CounterSetUid == 0);
1500 BOOST_CHECK(category->m_Counters.size() == 20);
Keith Davis3201eea2019-10-24 17:30:41 +01001501 for (size_t i = 0; i < numberOfCores; i++)
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001502 {
1503 BOOST_CHECK(category->m_Counters[category->m_Counters.size() - numberOfCores + i] ==
1504 counterWNumberOfCores->m_Uid + i);
1505 }
1506
1507 // Register a multi-core device for testing
1508 const std::string multiCoreDeviceName = "some_multi_core_device";
Keith Davis3201eea2019-10-24 17:30:41 +01001509 const Device* multiCoreDevice = nullptr;
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001510 BOOST_CHECK_NO_THROW(multiCoreDevice = counterDirectory.RegisterDevice(multiCoreDeviceName, 4));
1511 BOOST_CHECK(counterDirectory.GetDeviceCount() == 2);
1512 BOOST_CHECK(multiCoreDevice);
1513 BOOST_CHECK(multiCoreDevice->m_Name == multiCoreDeviceName);
1514 BOOST_CHECK(multiCoreDevice->m_Uid >= 1);
1515 BOOST_CHECK(multiCoreDevice->m_Cores == 4);
1516
1517 // Register a counter with a valid parent category name and associated to the multi-core device
1518 const Counter* counterWMultiCoreDevice = nullptr;
Keith Davis3201eea2019-10-24 17:30:41 +01001519 BOOST_CHECK_NO_THROW(counterWMultiCoreDevice = counterDirectory.RegisterCounter(
Keith Davise394bd92019-12-02 15:12:19 +00001520 armnn::profiling::BACKEND_ID, 19, categoryName, 0, 1,
1521 123.45f, "valid name 9", "valid description",
Keith Davis3201eea2019-10-24 17:30:41 +01001522 armnn::EmptyOptional(), // Units
1523 armnn::EmptyOptional(), // Number of cores
1524 multiCoreDevice->m_Uid, // Device UID
1525 armnn::EmptyOptional())); // Counter set UID
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001526 BOOST_CHECK(counterDirectory.GetCounterCount() == 24);
1527 BOOST_CHECK(counterWMultiCoreDevice);
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001528 BOOST_CHECK(counterWMultiCoreDevice->m_Uid > counter->m_Uid);
1529 BOOST_CHECK(counterWMultiCoreDevice->m_MaxCounterUid ==
1530 counterWMultiCoreDevice->m_Uid + multiCoreDevice->m_Cores - 1);
1531 BOOST_CHECK(counterWMultiCoreDevice->m_Class == 0);
1532 BOOST_CHECK(counterWMultiCoreDevice->m_Interpolation == 1);
1533 BOOST_CHECK(counterWMultiCoreDevice->m_Multiplier == 123.45f);
1534 BOOST_CHECK(counterWMultiCoreDevice->m_Name == "valid name 9");
1535 BOOST_CHECK(counterWMultiCoreDevice->m_Description == "valid description");
1536 BOOST_CHECK(counterWMultiCoreDevice->m_Units == "");
1537 BOOST_CHECK(counterWMultiCoreDevice->m_DeviceUid == multiCoreDevice->m_Uid);
1538 BOOST_CHECK(counterWMultiCoreDevice->m_CounterSetUid == 0);
1539 BOOST_CHECK(category->m_Counters.size() == 24);
Keith Davis3201eea2019-10-24 17:30:41 +01001540 for (size_t i = 0; i < 4; i++)
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001541 {
1542 BOOST_CHECK(category->m_Counters[category->m_Counters.size() - 4 + i] == counterWMultiCoreDevice->m_Uid + i);
1543 }
1544
Matteo Martincigh657ab2d2019-09-18 10:53:24 +01001545 // Register a multi-core device associate to a parent category for testing
1546 const std::string multiCoreDeviceNameWParentCategory = "some_multi_core_device_with_parent_category";
Keith Davis3201eea2019-10-24 17:30:41 +01001547 const Device* multiCoreDeviceWParentCategory = nullptr;
Matteo Martincigh657ab2d2019-09-18 10:53:24 +01001548 BOOST_CHECK_NO_THROW(multiCoreDeviceWParentCategory =
Keith Davis3201eea2019-10-24 17:30:41 +01001549 counterDirectory.RegisterDevice(multiCoreDeviceNameWParentCategory, 2, categoryName));
Matteo Martincigh657ab2d2019-09-18 10:53:24 +01001550 BOOST_CHECK(counterDirectory.GetDeviceCount() == 3);
1551 BOOST_CHECK(multiCoreDeviceWParentCategory);
1552 BOOST_CHECK(multiCoreDeviceWParentCategory->m_Name == multiCoreDeviceNameWParentCategory);
1553 BOOST_CHECK(multiCoreDeviceWParentCategory->m_Uid >= 1);
1554 BOOST_CHECK(multiCoreDeviceWParentCategory->m_Cores == 2);
1555
1556 // Register a counter with a valid parent category name and getting the number of cores of the multi-core device
1557 // associated to that category
1558 const Counter* counterWMultiCoreDeviceWParentCategory = nullptr;
Sadik Armagan4c998992020-02-25 12:44:44 +00001559 uint16_t numberOfCourse = multiCoreDeviceWParentCategory->m_Cores;
Keith Davise394bd92019-12-02 15:12:19 +00001560 BOOST_CHECK_NO_THROW(counterWMultiCoreDeviceWParentCategory =
1561 counterDirectory.RegisterCounter(armnn::profiling::BACKEND_ID,
1562 100,
1563 categoryName,
1564 0,
1565 1,
1566 123.45f,
1567 "valid name 10",
1568 "valid description",
Sadik Armagan4c998992020-02-25 12:44:44 +00001569 armnn::EmptyOptional(), // Units
1570 numberOfCourse, // Number of cores
1571 armnn::EmptyOptional(), // Device UID
Keith Davise394bd92019-12-02 15:12:19 +00001572 armnn::EmptyOptional()));// Counter set UID
Matteo Martincigh657ab2d2019-09-18 10:53:24 +01001573 BOOST_CHECK(counterDirectory.GetCounterCount() == 26);
1574 BOOST_CHECK(counterWMultiCoreDeviceWParentCategory);
Matteo Martincigh657ab2d2019-09-18 10:53:24 +01001575 BOOST_CHECK(counterWMultiCoreDeviceWParentCategory->m_Uid > counter->m_Uid);
1576 BOOST_CHECK(counterWMultiCoreDeviceWParentCategory->m_MaxCounterUid ==
1577 counterWMultiCoreDeviceWParentCategory->m_Uid + multiCoreDeviceWParentCategory->m_Cores - 1);
1578 BOOST_CHECK(counterWMultiCoreDeviceWParentCategory->m_Class == 0);
1579 BOOST_CHECK(counterWMultiCoreDeviceWParentCategory->m_Interpolation == 1);
1580 BOOST_CHECK(counterWMultiCoreDeviceWParentCategory->m_Multiplier == 123.45f);
1581 BOOST_CHECK(counterWMultiCoreDeviceWParentCategory->m_Name == "valid name 10");
1582 BOOST_CHECK(counterWMultiCoreDeviceWParentCategory->m_Description == "valid description");
1583 BOOST_CHECK(counterWMultiCoreDeviceWParentCategory->m_Units == "");
Matteo Martincigh657ab2d2019-09-18 10:53:24 +01001584 BOOST_CHECK(category->m_Counters.size() == 26);
Keith Davis3201eea2019-10-24 17:30:41 +01001585 for (size_t i = 0; i < 2; i++)
Matteo Martincigh657ab2d2019-09-18 10:53:24 +01001586 {
1587 BOOST_CHECK(category->m_Counters[category->m_Counters.size() - 2 + i] ==
1588 counterWMultiCoreDeviceWParentCategory->m_Uid + i);
1589 }
1590
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001591 // Register a counter set for testing
1592 const std::string counterSetName = "some_counter_set";
Keith Davis3201eea2019-10-24 17:30:41 +01001593 const CounterSet* counterSet = nullptr;
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001594 BOOST_CHECK_NO_THROW(counterSet = counterDirectory.RegisterCounterSet(counterSetName));
1595 BOOST_CHECK(counterDirectory.GetCounterSetCount() == 1);
1596 BOOST_CHECK(counterSet);
1597 BOOST_CHECK(counterSet->m_Name == counterSetName);
1598 BOOST_CHECK(counterSet->m_Uid >= 1);
1599 BOOST_CHECK(counterSet->m_Count == 0);
1600
1601 // Register a counter with a valid parent category name and associated to a counter set
1602 const Counter* counterWCounterSet = nullptr;
Keith Davis3201eea2019-10-24 17:30:41 +01001603 BOOST_CHECK_NO_THROW(counterWCounterSet = counterDirectory.RegisterCounter(
Keith Davise394bd92019-12-02 15:12:19 +00001604 armnn::profiling::BACKEND_ID, 300,
Keith Davis3201eea2019-10-24 17:30:41 +01001605 categoryName, 0, 1, 123.45f, "valid name 11", "valid description",
1606 armnn::EmptyOptional(), // Units
1607 0, // Number of cores
1608 armnn::EmptyOptional(), // Device UID
1609 counterSet->m_Uid)); // Counter set UID
Matteo Martincigh657ab2d2019-09-18 10:53:24 +01001610 BOOST_CHECK(counterDirectory.GetCounterCount() == 27);
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001611 BOOST_CHECK(counterWCounterSet);
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001612 BOOST_CHECK(counterWCounterSet->m_Uid > counter->m_Uid);
1613 BOOST_CHECK(counterWCounterSet->m_MaxCounterUid == counterWCounterSet->m_Uid);
1614 BOOST_CHECK(counterWCounterSet->m_Class == 0);
1615 BOOST_CHECK(counterWCounterSet->m_Interpolation == 1);
1616 BOOST_CHECK(counterWCounterSet->m_Multiplier == 123.45f);
Matteo Martincigh657ab2d2019-09-18 10:53:24 +01001617 BOOST_CHECK(counterWCounterSet->m_Name == "valid name 11");
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001618 BOOST_CHECK(counterWCounterSet->m_Description == "valid description");
1619 BOOST_CHECK(counterWCounterSet->m_Units == "");
1620 BOOST_CHECK(counterWCounterSet->m_DeviceUid == 0);
1621 BOOST_CHECK(counterWCounterSet->m_CounterSetUid == counterSet->m_Uid);
Matteo Martincigh657ab2d2019-09-18 10:53:24 +01001622 BOOST_CHECK(category->m_Counters.size() == 27);
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001623 BOOST_CHECK(category->m_Counters.back() == counterWCounterSet->m_Uid);
1624
1625 // Register a counter with a valid parent category name and associated to a device and a counter set
1626 const Counter* counterWDeviceWCounterSet = nullptr;
Keith Davis3201eea2019-10-24 17:30:41 +01001627 BOOST_CHECK_NO_THROW(counterWDeviceWCounterSet = counterDirectory.RegisterCounter(
Keith Davise394bd92019-12-02 15:12:19 +00001628 armnn::profiling::BACKEND_ID, 23,
Keith Davis3201eea2019-10-24 17:30:41 +01001629 categoryName, 0, 1, 123.45f, "valid name 12", "valid description",
1630 armnn::EmptyOptional(), // Units
1631 1, // Number of cores
1632 device->m_Uid, // Device UID
1633 counterSet->m_Uid)); // Counter set UID
Matteo Martincigh657ab2d2019-09-18 10:53:24 +01001634 BOOST_CHECK(counterDirectory.GetCounterCount() == 28);
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001635 BOOST_CHECK(counterWDeviceWCounterSet);
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001636 BOOST_CHECK(counterWDeviceWCounterSet->m_Uid > counter->m_Uid);
1637 BOOST_CHECK(counterWDeviceWCounterSet->m_MaxCounterUid == counterWDeviceWCounterSet->m_Uid);
1638 BOOST_CHECK(counterWDeviceWCounterSet->m_Class == 0);
1639 BOOST_CHECK(counterWDeviceWCounterSet->m_Interpolation == 1);
1640 BOOST_CHECK(counterWDeviceWCounterSet->m_Multiplier == 123.45f);
Matteo Martincigh657ab2d2019-09-18 10:53:24 +01001641 BOOST_CHECK(counterWDeviceWCounterSet->m_Name == "valid name 12");
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001642 BOOST_CHECK(counterWDeviceWCounterSet->m_Description == "valid description");
1643 BOOST_CHECK(counterWDeviceWCounterSet->m_Units == "");
1644 BOOST_CHECK(counterWDeviceWCounterSet->m_DeviceUid == device->m_Uid);
1645 BOOST_CHECK(counterWDeviceWCounterSet->m_CounterSetUid == counterSet->m_Uid);
Matteo Martincigh657ab2d2019-09-18 10:53:24 +01001646 BOOST_CHECK(category->m_Counters.size() == 28);
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001647 BOOST_CHECK(category->m_Counters.back() == counterWDeviceWCounterSet->m_Uid);
1648
1649 // Register another category for testing
1650 const std::string anotherCategoryName = "some_other_category";
Keith Davis3201eea2019-10-24 17:30:41 +01001651 const Category* anotherCategory = nullptr;
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001652 BOOST_CHECK_NO_THROW(anotherCategory = counterDirectory.RegisterCategory(anotherCategoryName));
1653 BOOST_CHECK(counterDirectory.GetCategoryCount() == 2);
1654 BOOST_CHECK(anotherCategory);
1655 BOOST_CHECK(anotherCategory != category);
1656 BOOST_CHECK(anotherCategory->m_Name == anotherCategoryName);
1657 BOOST_CHECK(anotherCategory->m_Counters.empty());
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001658
1659 // Register a counter to the other category
1660 const Counter* anotherCounter = nullptr;
Keith Davise394bd92019-12-02 15:12:19 +00001661 BOOST_CHECK_NO_THROW(anotherCounter = counterDirectory.RegisterCounter(armnn::profiling::BACKEND_ID, 24,
1662 anotherCategoryName, 1, 0, .00043f,
Keith Davis3201eea2019-10-24 17:30:41 +01001663 "valid name", "valid description",
1664 armnn::EmptyOptional(), // Units
1665 armnn::EmptyOptional(), // Number of cores
1666 device->m_Uid, // Device UID
1667 counterSet->m_Uid)); // Counter set UID
Matteo Martincigh657ab2d2019-09-18 10:53:24 +01001668 BOOST_CHECK(counterDirectory.GetCounterCount() == 29);
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001669 BOOST_CHECK(anotherCounter);
Matteo Martincigh6db5f202019-09-05 12:02:04 +01001670 BOOST_CHECK(anotherCounter->m_MaxCounterUid == anotherCounter->m_Uid);
1671 BOOST_CHECK(anotherCounter->m_Class == 1);
1672 BOOST_CHECK(anotherCounter->m_Interpolation == 0);
1673 BOOST_CHECK(anotherCounter->m_Multiplier == .00043f);
1674 BOOST_CHECK(anotherCounter->m_Name == "valid name");
1675 BOOST_CHECK(anotherCounter->m_Description == "valid description");
1676 BOOST_CHECK(anotherCounter->m_Units == "");
1677 BOOST_CHECK(anotherCounter->m_DeviceUid == device->m_Uid);
1678 BOOST_CHECK(anotherCounter->m_CounterSetUid == counterSet->m_Uid);
1679 BOOST_CHECK(anotherCategory->m_Counters.size() == 1);
1680 BOOST_CHECK(anotherCategory->m_Counters.back() == anotherCounter->m_Uid);
Matteo Martincighab173e92019-09-05 12:02:04 +01001681}
1682
Ferran Balaguer1b941722019-08-28 16:57:18 +01001683BOOST_AUTO_TEST_CASE(CounterSelectionCommandHandlerParseData)
1684{
1685 using boost::numeric_cast;
1686
Matteo Martincigh5d737fb2019-10-07 13:05:13 +01001687 ProfilingStateMachine profilingStateMachine;
1688
Ferran Balaguer1b941722019-08-28 16:57:18 +01001689 class TestCaptureThread : public IPeriodicCounterCapture
1690 {
Keith Davis3201eea2019-10-24 17:30:41 +01001691 void Start() override
1692 {}
1693 void Stop() override
1694 {}
Ferran Balaguer1b941722019-08-28 16:57:18 +01001695 };
1696
Matteo Martincighe8485382019-10-10 14:08:21 +01001697 class TestReadCounterValues : public IReadCounterValues
1698 {
Keith Davis3201eea2019-10-24 17:30:41 +01001699 bool IsCounterRegistered(uint16_t counterUid) const override
1700 {
Jan Eilers8eb25602020-03-09 12:13:48 +00001701 armnn::IgnoreUnused(counterUid);
Keith Davis3201eea2019-10-24 17:30:41 +01001702 return true;
1703 }
1704 uint16_t GetCounterCount() const override
1705 {
1706 return 0;
1707 }
1708 uint32_t GetCounterValue(uint16_t counterUid) const override
1709 {
Jan Eilers8eb25602020-03-09 12:13:48 +00001710 armnn::IgnoreUnused(counterUid);
Keith Davis3201eea2019-10-24 17:30:41 +01001711 return 0;
1712 }
Matteo Martincighe8485382019-10-10 14:08:21 +01001713 };
Jim Flynn397043f2019-10-17 17:37:10 +01001714 const uint32_t familyId = 0;
Ferran Balaguer1b941722019-08-28 16:57:18 +01001715 const uint32_t packetId = 0x40000;
1716
1717 uint32_t version = 1;
Finn Williams032bc742020-02-12 11:02:34 +00001718 const std::unordered_map<armnn::BackendId,
1719 std::shared_ptr<armnn::profiling::IBackendProfilingContext>> backendProfilingContext;
1720 CounterIdMap counterIdMap;
Ferran Balaguer1b941722019-08-28 16:57:18 +01001721 Holder holder;
1722 TestCaptureThread captureThread;
Matteo Martincighe8485382019-10-10 14:08:21 +01001723 TestReadCounterValues readCounterValues;
Narumol Prangnawarat404b2752019-09-24 17:23:16 +01001724 MockBufferManager mockBuffer(512);
Sadik Armagan3896b472020-02-10 12:24:15 +00001725 SendCounterPacket sendCounterPacket(mockBuffer);
1726 SendThread sendThread(profilingStateMachine, mockBuffer, sendCounterPacket);
Ferran Balaguer1b941722019-08-28 16:57:18 +01001727
1728 uint32_t sizeOfUint32 = numeric_cast<uint32_t>(sizeof(uint32_t));
1729 uint32_t sizeOfUint16 = numeric_cast<uint32_t>(sizeof(uint16_t));
1730
1731 // Data with period and counters
Colm Donelan02705242019-11-14 14:19:07 +00001732 uint32_t period1 = armnn::LOWEST_CAPTURE_PERIOD;
Ferran Balaguer1b941722019-08-28 16:57:18 +01001733 uint32_t dataLength1 = 8;
Keith Davis3201eea2019-10-24 17:30:41 +01001734 uint32_t offset = 0;
Ferran Balaguer1b941722019-08-28 16:57:18 +01001735
Matteo Martincigh67ef2a52019-10-10 13:29:02 +01001736 std::unique_ptr<unsigned char[]> uniqueData1 = std::make_unique<unsigned char[]>(dataLength1);
Keith Davis3201eea2019-10-24 17:30:41 +01001737 unsigned char* data1 = reinterpret_cast<unsigned char*>(uniqueData1.get());
FinnWilliamsArma0c78712019-09-16 12:06:47 +01001738
Ferran Balaguer1b941722019-08-28 16:57:18 +01001739 WriteUint32(data1, offset, period1);
1740 offset += sizeOfUint32;
1741 WriteUint16(data1, offset, 4000);
1742 offset += sizeOfUint16;
1743 WriteUint16(data1, offset, 5000);
1744
FinnWilliamsArma0c78712019-09-16 12:06:47 +01001745 Packet packetA(packetId, dataLength1, uniqueData1);
Ferran Balaguer1b941722019-08-28 16:57:18 +01001746
Finn Williams032bc742020-02-12 11:02:34 +00001747 PeriodicCounterSelectionCommandHandler commandHandler(familyId, packetId, version, backendProfilingContext,
1748 counterIdMap, holder, 10000u, captureThread,
Keith Davis3201eea2019-10-24 17:30:41 +01001749 readCounterValues, sendCounterPacket, profilingStateMachine);
Ferran Balaguer1b941722019-08-28 16:57:18 +01001750
Matteo Martincighe8485382019-10-10 14:08:21 +01001751 profilingStateMachine.TransitionToState(ProfilingState::Uninitialised);
1752 BOOST_CHECK_THROW(commandHandler(packetA), armnn::RuntimeException);
1753 profilingStateMachine.TransitionToState(ProfilingState::NotConnected);
1754 BOOST_CHECK_THROW(commandHandler(packetA), armnn::RuntimeException);
1755 profilingStateMachine.TransitionToState(ProfilingState::WaitingForAck);
1756 BOOST_CHECK_THROW(commandHandler(packetA), armnn::RuntimeException);
1757 profilingStateMachine.TransitionToState(ProfilingState::Active);
1758 BOOST_CHECK_NO_THROW(commandHandler(packetA));
1759
1760 const std::vector<uint16_t> counterIdsA = holder.GetCaptureData().GetCounterIds();
Ferran Balaguer1b941722019-08-28 16:57:18 +01001761
1762 BOOST_TEST(holder.GetCaptureData().GetCapturePeriod() == period1);
Matteo Martincighe8485382019-10-10 14:08:21 +01001763 BOOST_TEST(counterIdsA.size() == 2);
1764 BOOST_TEST(counterIdsA[0] == 4000);
1765 BOOST_TEST(counterIdsA[1] == 5000);
Ferran Balaguer1b941722019-08-28 16:57:18 +01001766
Narumol Prangnawarat404b2752019-09-24 17:23:16 +01001767 auto readBuffer = mockBuffer.GetReadableBuffer();
Ferran Balaguer1b941722019-08-28 16:57:18 +01001768
1769 offset = 0;
1770
1771 uint32_t headerWord0 = ReadUint32(readBuffer, offset);
1772 offset += sizeOfUint32;
1773 uint32_t headerWord1 = ReadUint32(readBuffer, offset);
1774 offset += sizeOfUint32;
1775 uint32_t period = ReadUint32(readBuffer, offset);
1776
Colm Donelan02705242019-11-14 14:19:07 +00001777 BOOST_TEST(((headerWord0 >> 26) & 0x3F) == 0); // packet family
1778 BOOST_TEST(((headerWord0 >> 16) & 0x3FF) == 4); // packet id
1779 BOOST_TEST(headerWord1 == 8); // data length
1780 BOOST_TEST(period == armnn::LOWEST_CAPTURE_PERIOD); // capture period
Ferran Balaguer1b941722019-08-28 16:57:18 +01001781
1782 uint16_t counterId = 0;
1783 offset += sizeOfUint32;
1784 counterId = ReadUint16(readBuffer, offset);
1785 BOOST_TEST(counterId == 4000);
1786 offset += sizeOfUint16;
1787 counterId = ReadUint16(readBuffer, offset);
1788 BOOST_TEST(counterId == 5000);
1789
Narumol Prangnawarat404b2752019-09-24 17:23:16 +01001790 mockBuffer.MarkRead(readBuffer);
1791
Ferran Balaguer1b941722019-08-28 16:57:18 +01001792 // Data with period only
Colm Donelan02705242019-11-14 14:19:07 +00001793 uint32_t period2 = 9000; // We'll specify a value below LOWEST_CAPTURE_PERIOD. It should be pulled upwards.
Ferran Balaguer1b941722019-08-28 16:57:18 +01001794 uint32_t dataLength2 = 4;
Ferran Balaguer1b941722019-08-28 16:57:18 +01001795
Matteo Martincigh67ef2a52019-10-10 13:29:02 +01001796 std::unique_ptr<unsigned char[]> uniqueData2 = std::make_unique<unsigned char[]>(dataLength2);
Ferran Balaguer1b941722019-08-28 16:57:18 +01001797
FinnWilliamsArma0c78712019-09-16 12:06:47 +01001798 WriteUint32(reinterpret_cast<unsigned char*>(uniqueData2.get()), 0, period2);
1799
1800 Packet packetB(packetId, dataLength2, uniqueData2);
Ferran Balaguer1b941722019-08-28 16:57:18 +01001801
1802 commandHandler(packetB);
1803
Matteo Martincighe8485382019-10-10 14:08:21 +01001804 const std::vector<uint16_t> counterIdsB = holder.GetCaptureData().GetCounterIds();
Ferran Balaguer1b941722019-08-28 16:57:18 +01001805
Colm Donelan02705242019-11-14 14:19:07 +00001806 // Value should have been pulled up from 9000 to LOWEST_CAPTURE_PERIOD.
1807 BOOST_TEST(holder.GetCaptureData().GetCapturePeriod() == armnn::LOWEST_CAPTURE_PERIOD);
Matteo Martincighe8485382019-10-10 14:08:21 +01001808 BOOST_TEST(counterIdsB.size() == 0);
Ferran Balaguer1b941722019-08-28 16:57:18 +01001809
Narumol Prangnawarat404b2752019-09-24 17:23:16 +01001810 readBuffer = mockBuffer.GetReadableBuffer();
Ferran Balaguer1b941722019-08-28 16:57:18 +01001811
1812 offset = 0;
1813
1814 headerWord0 = ReadUint32(readBuffer, offset);
1815 offset += sizeOfUint32;
1816 headerWord1 = ReadUint32(readBuffer, offset);
1817 offset += sizeOfUint32;
1818 period = ReadUint32(readBuffer, offset);
1819
Colm Donelan02705242019-11-14 14:19:07 +00001820 BOOST_TEST(((headerWord0 >> 26) & 0x3F) == 0); // packet family
1821 BOOST_TEST(((headerWord0 >> 16) & 0x3FF) == 4); // packet id
1822 BOOST_TEST(headerWord1 == 4); // data length
1823 BOOST_TEST(period == armnn::LOWEST_CAPTURE_PERIOD); // capture period
Ferran Balaguer1b941722019-08-28 16:57:18 +01001824}
1825
Keith Davis33ed2212020-03-30 10:43:41 +01001826BOOST_AUTO_TEST_CASE(CheckTimelineActivationAndDeactivation)
1827{
1828 class TestReportStructure : public IReportStructure
1829 {
1830 public:
1831 virtual void ReportStructure() override
1832 {
1833 m_ReportStructureCalled = true;
1834 }
1835
1836 bool m_ReportStructureCalled = false;
1837 };
1838
1839 class TestNotifyBackends : public INotifyBackends
1840 {
1841 public:
1842 TestNotifyBackends() : m_timelineReporting(false) {}
1843 virtual void NotifyBackendsForTimelineReporting() override
1844 {
1845 m_TestNotifyBackendsCalled = m_timelineReporting.load();
1846 }
1847
1848 bool m_TestNotifyBackendsCalled = false;
1849 std::atomic<bool> m_timelineReporting;
1850 };
1851
1852 PacketVersionResolver packetVersionResolver;
1853
1854 BufferManager bufferManager(512);
1855 SendTimelinePacket sendTimelinePacket(bufferManager);
1856 ProfilingStateMachine stateMachine;
1857 TestReportStructure testReportStructure;
1858 TestNotifyBackends testNotifyBackends;
1859
1860 profiling::ActivateTimelineReportingCommandHandler activateTimelineReportingCommandHandler(0,
1861 6,
1862 packetVersionResolver.ResolvePacketVersion(0, 6)
1863 .GetEncodedValue(),
1864 sendTimelinePacket,
1865 stateMachine,
1866 testReportStructure,
1867 testNotifyBackends.m_timelineReporting,
1868 testNotifyBackends);
1869
1870 // Write an "ActivateTimelineReporting" packet into the mock profiling connection, to simulate an input from an
1871 // external profiling service
1872 const uint32_t packetFamily1 = 0;
1873 const uint32_t packetId1 = 6;
1874 uint32_t packetHeader1 = ConstructHeader(packetFamily1, packetId1);
1875
1876 // Create the ActivateTimelineReportingPacket
1877 Packet ActivateTimelineReportingPacket(packetHeader1); // Length == 0
1878
1879 BOOST_CHECK_THROW(
1880 activateTimelineReportingCommandHandler.operator()(ActivateTimelineReportingPacket), armnn::Exception);
1881
1882 stateMachine.TransitionToState(ProfilingState::NotConnected);
1883 BOOST_CHECK_THROW(
1884 activateTimelineReportingCommandHandler.operator()(ActivateTimelineReportingPacket), armnn::Exception);
1885
1886 stateMachine.TransitionToState(ProfilingState::WaitingForAck);
1887 BOOST_CHECK_THROW(
1888 activateTimelineReportingCommandHandler.operator()(ActivateTimelineReportingPacket), armnn::Exception);
1889
1890 stateMachine.TransitionToState(ProfilingState::Active);
1891 activateTimelineReportingCommandHandler.operator()(ActivateTimelineReportingPacket);
1892
1893 BOOST_CHECK(testReportStructure.m_ReportStructureCalled);
1894 BOOST_CHECK(testNotifyBackends.m_TestNotifyBackendsCalled);
1895 BOOST_CHECK(testNotifyBackends.m_timelineReporting.load());
1896
1897 DeactivateTimelineReportingCommandHandler deactivateTimelineReportingCommandHandler(0,
1898 7,
1899 packetVersionResolver.ResolvePacketVersion(0, 7).GetEncodedValue(),
1900 testNotifyBackends.m_timelineReporting,
1901 stateMachine,
1902 testNotifyBackends);
1903
1904 const uint32_t packetFamily2 = 0;
1905 const uint32_t packetId2 = 7;
1906 uint32_t packetHeader2 = ConstructHeader(packetFamily2, packetId2);
1907
1908 // Create the DeactivateTimelineReportingPacket
1909 Packet deactivateTimelineReportingPacket(packetHeader2); // Length == 0
1910
1911 stateMachine.Reset();
1912 BOOST_CHECK_THROW(
1913 deactivateTimelineReportingCommandHandler.operator()(deactivateTimelineReportingPacket), armnn::Exception);
1914
1915 stateMachine.TransitionToState(ProfilingState::NotConnected);
1916 BOOST_CHECK_THROW(
1917 deactivateTimelineReportingCommandHandler.operator()(deactivateTimelineReportingPacket), armnn::Exception);
1918
1919 stateMachine.TransitionToState(ProfilingState::WaitingForAck);
1920 BOOST_CHECK_THROW(
1921 deactivateTimelineReportingCommandHandler.operator()(deactivateTimelineReportingPacket), armnn::Exception);
1922
1923 stateMachine.TransitionToState(ProfilingState::Active);
1924 deactivateTimelineReportingCommandHandler.operator()(deactivateTimelineReportingPacket);
1925
1926 BOOST_CHECK(!testNotifyBackends.m_TestNotifyBackendsCalled);
1927 BOOST_CHECK(!testNotifyBackends.m_timelineReporting.load());
1928}
1929
1930BOOST_AUTO_TEST_CASE(CheckProfilingServiceNotActive)
1931{
1932 using namespace armnn;
1933 using namespace armnn::profiling;
1934
1935 // Create runtime in which the test will run
1936 armnn::IRuntime::CreationOptions options;
1937 options.m_ProfilingOptions.m_EnableProfiling = true;
1938
1939 armnn::Runtime runtime(options);
1940 profiling::ProfilingServiceRuntimeHelper profilingServiceHelper(GetProfilingService(&runtime));
1941 profilingServiceHelper.ForceTransitionToState(ProfilingState::NotConnected);
1942 profilingServiceHelper.ForceTransitionToState(ProfilingState::WaitingForAck);
1943 profilingServiceHelper.ForceTransitionToState(ProfilingState::Active);
1944
1945 profiling::BufferManager& bufferManager = profilingServiceHelper.GetProfilingBufferManager();
1946 auto readableBuffer = bufferManager.GetReadableBuffer();
1947
1948 // Profiling is enabled, the post-optimisation structure should be created
1949 BOOST_CHECK(readableBuffer == nullptr);
1950}
1951
Sadik Armaganb5f01b22019-09-18 17:29:00 +01001952BOOST_AUTO_TEST_CASE(CheckConnectionAcknowledged)
1953{
1954 using boost::numeric_cast;
1955
Keith Davis3201eea2019-10-24 17:30:41 +01001956 const uint32_t packetFamilyId = 0;
Sadik Armaganb5f01b22019-09-18 17:29:00 +01001957 const uint32_t connectionPacketId = 0x10000;
Keith Davis3201eea2019-10-24 17:30:41 +01001958 const uint32_t version = 1;
Sadik Armaganb5f01b22019-09-18 17:29:00 +01001959
1960 uint32_t sizeOfUint32 = numeric_cast<uint32_t>(sizeof(uint32_t));
1961 uint32_t sizeOfUint16 = numeric_cast<uint32_t>(sizeof(uint16_t));
1962
1963 // Data with period and counters
Keith Davis3201eea2019-10-24 17:30:41 +01001964 uint32_t period1 = 10;
Sadik Armaganb5f01b22019-09-18 17:29:00 +01001965 uint32_t dataLength1 = 8;
Keith Davis3201eea2019-10-24 17:30:41 +01001966 uint32_t offset = 0;
Sadik Armaganb5f01b22019-09-18 17:29:00 +01001967
Matteo Martincigh67ef2a52019-10-10 13:29:02 +01001968 std::unique_ptr<unsigned char[]> uniqueData1 = std::make_unique<unsigned char[]>(dataLength1);
Keith Davis3201eea2019-10-24 17:30:41 +01001969 unsigned char* data1 = reinterpret_cast<unsigned char*>(uniqueData1.get());
Sadik Armaganb5f01b22019-09-18 17:29:00 +01001970
1971 WriteUint32(data1, offset, period1);
1972 offset += sizeOfUint32;
1973 WriteUint16(data1, offset, 4000);
1974 offset += sizeOfUint16;
1975 WriteUint16(data1, offset, 5000);
1976
1977 Packet packetA(connectionPacketId, dataLength1, uniqueData1);
1978
1979 ProfilingStateMachine profilingState(ProfilingState::Uninitialised);
1980 BOOST_CHECK(profilingState.GetCurrentState() == ProfilingState::Uninitialised);
Keith Davis3201eea2019-10-24 17:30:41 +01001981 CounterDirectory counterDirectory;
1982 MockBufferManager mockBuffer(1024);
Sadik Armagan3896b472020-02-10 12:24:15 +00001983 SendCounterPacket sendCounterPacket(mockBuffer);
1984 SendThread sendThread(profilingState, mockBuffer, sendCounterPacket);
Matteo Martincighcdfb9412019-11-08 11:23:06 +00001985 SendTimelinePacket sendTimelinePacket(mockBuffer);
Sadik Armaganb5f01b22019-09-18 17:29:00 +01001986
Keith Davis3201eea2019-10-24 17:30:41 +01001987 ConnectionAcknowledgedCommandHandler commandHandler(packetFamilyId, connectionPacketId, version, counterDirectory,
Matteo Martincighcdfb9412019-11-08 11:23:06 +00001988 sendCounterPacket, sendTimelinePacket, profilingState);
Sadik Armaganb5f01b22019-09-18 17:29:00 +01001989
1990 // command handler received packet on ProfilingState::Uninitialised
1991 BOOST_CHECK_THROW(commandHandler(packetA), armnn::Exception);
1992
1993 profilingState.TransitionToState(ProfilingState::NotConnected);
1994 BOOST_CHECK(profilingState.GetCurrentState() == ProfilingState::NotConnected);
1995 // command handler received packet on ProfilingState::NotConnected
1996 BOOST_CHECK_THROW(commandHandler(packetA), armnn::Exception);
1997
1998 profilingState.TransitionToState(ProfilingState::WaitingForAck);
1999 BOOST_CHECK(profilingState.GetCurrentState() == ProfilingState::WaitingForAck);
2000 // command handler received packet on ProfilingState::WaitingForAck
Matteo Martincighd0613b52019-10-09 16:47:04 +01002001 BOOST_CHECK_NO_THROW(commandHandler(packetA));
Sadik Armaganb5f01b22019-09-18 17:29:00 +01002002 BOOST_CHECK(profilingState.GetCurrentState() == ProfilingState::Active);
2003
2004 // command handler received packet on ProfilingState::Active
Matteo Martincighd0613b52019-10-09 16:47:04 +01002005 BOOST_CHECK_NO_THROW(commandHandler(packetA));
Sadik Armaganb5f01b22019-09-18 17:29:00 +01002006 BOOST_CHECK(profilingState.GetCurrentState() == ProfilingState::Active);
2007
2008 // command handler received different packet
2009 const uint32_t differentPacketId = 0x40000;
2010 Packet packetB(differentPacketId, dataLength1, uniqueData1);
Matteo Martincighd0613b52019-10-09 16:47:04 +01002011 profilingState.TransitionToState(ProfilingState::NotConnected);
2012 profilingState.TransitionToState(ProfilingState::WaitingForAck);
Keith Davis3201eea2019-10-24 17:30:41 +01002013 ConnectionAcknowledgedCommandHandler differentCommandHandler(packetFamilyId, differentPacketId, version,
Matteo Martincighcdfb9412019-11-08 11:23:06 +00002014 counterDirectory, sendCounterPacket,
2015 sendTimelinePacket, profilingState);
Sadik Armaganb5f01b22019-09-18 17:29:00 +01002016 BOOST_CHECK_THROW(differentCommandHandler(packetB), armnn::Exception);
2017}
2018
Sadik Armagana97a0be2020-03-03 10:44:56 +00002019BOOST_AUTO_TEST_CASE(CheckSocketConnectionException)
Teresa Charlin9bab4962019-09-06 12:28:35 +01002020{
Sadik Armagana97a0be2020-03-03 10:44:56 +00002021 // Check that creating a SocketProfilingConnection armnnProfiling in an exception as the Gator UDS doesn't exist.
2022 BOOST_CHECK_THROW(new SocketProfilingConnection(), armnnProfiling::SocketConnectionException);
2023}
2024
2025BOOST_AUTO_TEST_CASE(CheckSocketConnectionException2)
2026{
2027 try
2028 {
2029 new SocketProfilingConnection();
2030 }
2031 catch (armnnProfiling::SocketConnectionException& ex)
2032 {
2033 BOOST_CHECK(ex.GetSocketFd() == 0);
2034 BOOST_CHECK(ex.GetErrorNo() == 111);
2035 BOOST_CHECK(ex.what()
2036 == std::string("SocketProfilingConnection: Cannot connect to stream socket: Connection refused"));
2037 }
Teresa Charlin9bab4962019-09-06 12:28:35 +01002038}
2039
Matteo Martincigh42f9d9e2019-09-05 12:02:04 +01002040BOOST_AUTO_TEST_CASE(SwTraceIsValidCharTest)
2041{
2042 // Only ASCII 7-bit encoding supported
2043 for (unsigned char c = 0; c < 128; c++)
2044 {
2045 BOOST_CHECK(SwTraceCharPolicy::IsValidChar(c));
2046 }
2047
2048 // Not ASCII
2049 for (unsigned char c = 255; c >= 128; c++)
2050 {
2051 BOOST_CHECK(!SwTraceCharPolicy::IsValidChar(c));
2052 }
2053}
2054
2055BOOST_AUTO_TEST_CASE(SwTraceIsValidNameCharTest)
2056{
2057 // Only alpha-numeric and underscore ASCII 7-bit encoding supported
2058 const unsigned char validChars[] = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_";
2059 for (unsigned char i = 0; i < sizeof(validChars) / sizeof(validChars[0]) - 1; i++)
2060 {
2061 BOOST_CHECK(SwTraceNameCharPolicy::IsValidChar(validChars[i]));
2062 }
2063
2064 // Non alpha-numeric chars
2065 for (unsigned char c = 0; c < 48; c++)
2066 {
2067 BOOST_CHECK(!SwTraceNameCharPolicy::IsValidChar(c));
2068 }
2069 for (unsigned char c = 58; c < 65; c++)
2070 {
2071 BOOST_CHECK(!SwTraceNameCharPolicy::IsValidChar(c));
2072 }
2073 for (unsigned char c = 91; c < 95; c++)
2074 {
2075 BOOST_CHECK(!SwTraceNameCharPolicy::IsValidChar(c));
2076 }
2077 for (unsigned char c = 96; c < 97; c++)
2078 {
2079 BOOST_CHECK(!SwTraceNameCharPolicy::IsValidChar(c));
2080 }
2081 for (unsigned char c = 123; c < 128; c++)
2082 {
2083 BOOST_CHECK(!SwTraceNameCharPolicy::IsValidChar(c));
2084 }
2085
2086 // Not ASCII
2087 for (unsigned char c = 255; c >= 128; c++)
2088 {
2089 BOOST_CHECK(!SwTraceNameCharPolicy::IsValidChar(c));
2090 }
2091}
2092
2093BOOST_AUTO_TEST_CASE(IsValidSwTraceStringTest)
2094{
2095 // Valid SWTrace strings
2096 BOOST_CHECK(IsValidSwTraceString<SwTraceCharPolicy>(""));
2097 BOOST_CHECK(IsValidSwTraceString<SwTraceCharPolicy>("_"));
2098 BOOST_CHECK(IsValidSwTraceString<SwTraceCharPolicy>("0123"));
2099 BOOST_CHECK(IsValidSwTraceString<SwTraceCharPolicy>("valid_string"));
2100 BOOST_CHECK(IsValidSwTraceString<SwTraceCharPolicy>("VALID_string_456"));
2101 BOOST_CHECK(IsValidSwTraceString<SwTraceCharPolicy>(" "));
2102 BOOST_CHECK(IsValidSwTraceString<SwTraceCharPolicy>("valid string"));
2103 BOOST_CHECK(IsValidSwTraceString<SwTraceCharPolicy>("!$%"));
2104 BOOST_CHECK(IsValidSwTraceString<SwTraceCharPolicy>("valid|\\~string#123"));
2105
2106 // Invalid SWTrace strings
2107 BOOST_CHECK(!IsValidSwTraceString<SwTraceCharPolicy>("€£"));
2108 BOOST_CHECK(!IsValidSwTraceString<SwTraceCharPolicy>("invalid‡string"));
2109 BOOST_CHECK(!IsValidSwTraceString<SwTraceCharPolicy>("12Ž34"));
2110}
2111
2112BOOST_AUTO_TEST_CASE(IsValidSwTraceNameStringTest)
2113{
2114 // Valid SWTrace name strings
2115 BOOST_CHECK(IsValidSwTraceString<SwTraceNameCharPolicy>(""));
2116 BOOST_CHECK(IsValidSwTraceString<SwTraceNameCharPolicy>("_"));
2117 BOOST_CHECK(IsValidSwTraceString<SwTraceNameCharPolicy>("0123"));
2118 BOOST_CHECK(IsValidSwTraceString<SwTraceNameCharPolicy>("valid_string"));
2119 BOOST_CHECK(IsValidSwTraceString<SwTraceNameCharPolicy>("VALID_string_456"));
2120
2121 // Invalid SWTrace name strings
2122 BOOST_CHECK(!IsValidSwTraceString<SwTraceNameCharPolicy>(" "));
2123 BOOST_CHECK(!IsValidSwTraceString<SwTraceNameCharPolicy>("invalid string"));
2124 BOOST_CHECK(!IsValidSwTraceString<SwTraceNameCharPolicy>("!$%"));
2125 BOOST_CHECK(!IsValidSwTraceString<SwTraceNameCharPolicy>("invalid|\\~string#123"));
2126 BOOST_CHECK(!IsValidSwTraceString<SwTraceNameCharPolicy>("€£"));
2127 BOOST_CHECK(!IsValidSwTraceString<SwTraceNameCharPolicy>("invalid‡string"));
2128 BOOST_CHECK(!IsValidSwTraceString<SwTraceNameCharPolicy>("12Ž34"));
2129}
2130
2131template <typename SwTracePolicy>
2132void StringToSwTraceStringTestHelper(const std::string& testString, std::vector<uint32_t> buffer, size_t expectedSize)
2133{
2134 // Convert the test string to a SWTrace string
2135 BOOST_CHECK(StringToSwTraceString<SwTracePolicy>(testString, buffer));
2136
2137 // The buffer must contain at least the length of the string
2138 BOOST_CHECK(!buffer.empty());
2139
2140 // The buffer must be of the expected size (in words)
2141 BOOST_CHECK(buffer.size() == expectedSize);
2142
2143 // The first word of the byte must be the length of the string including the null-terminator
2144 BOOST_CHECK(buffer[0] == testString.size() + 1);
2145
2146 // The contents of the buffer must match the test string
2147 BOOST_CHECK(std::memcmp(testString.data(), buffer.data() + 1, testString.size()) == 0);
2148
2149 // The buffer must include the null-terminator at the end of the string
2150 size_t nullTerminatorIndex = sizeof(uint32_t) + testString.size();
Keith Davis3201eea2019-10-24 17:30:41 +01002151 BOOST_CHECK(reinterpret_cast<unsigned char*>(buffer.data())[nullTerminatorIndex] == '\0');
Matteo Martincigh42f9d9e2019-09-05 12:02:04 +01002152}
2153
2154BOOST_AUTO_TEST_CASE(StringToSwTraceStringTest)
2155{
2156 std::vector<uint32_t> buffer;
2157
2158 // Valid SWTrace strings (expected size in words)
2159 StringToSwTraceStringTestHelper<SwTraceCharPolicy>("", buffer, 2);
2160 StringToSwTraceStringTestHelper<SwTraceCharPolicy>("_", buffer, 2);
2161 StringToSwTraceStringTestHelper<SwTraceCharPolicy>("0123", buffer, 3);
2162 StringToSwTraceStringTestHelper<SwTraceCharPolicy>("valid_string", buffer, 5);
2163 StringToSwTraceStringTestHelper<SwTraceCharPolicy>("VALID_string_456", buffer, 6);
2164 StringToSwTraceStringTestHelper<SwTraceCharPolicy>(" ", buffer, 2);
2165 StringToSwTraceStringTestHelper<SwTraceCharPolicy>("valid string", buffer, 5);
2166 StringToSwTraceStringTestHelper<SwTraceCharPolicy>("!$%", buffer, 2);
2167 StringToSwTraceStringTestHelper<SwTraceCharPolicy>("valid|\\~string#123", buffer, 6);
2168
2169 // Invalid SWTrace strings
2170 BOOST_CHECK(!StringToSwTraceString<SwTraceCharPolicy>("€£", buffer));
2171 BOOST_CHECK(buffer.empty());
2172 BOOST_CHECK(!StringToSwTraceString<SwTraceCharPolicy>("invalid‡string", buffer));
2173 BOOST_CHECK(buffer.empty());
2174 BOOST_CHECK(!StringToSwTraceString<SwTraceCharPolicy>("12Ž34", buffer));
2175 BOOST_CHECK(buffer.empty());
2176}
2177
2178BOOST_AUTO_TEST_CASE(StringToSwTraceNameStringTest)
2179{
2180 std::vector<uint32_t> buffer;
2181
2182 // Valid SWTrace namestrings (expected size in words)
2183 StringToSwTraceStringTestHelper<SwTraceNameCharPolicy>("", buffer, 2);
2184 StringToSwTraceStringTestHelper<SwTraceNameCharPolicy>("_", buffer, 2);
2185 StringToSwTraceStringTestHelper<SwTraceNameCharPolicy>("0123", buffer, 3);
2186 StringToSwTraceStringTestHelper<SwTraceNameCharPolicy>("valid_string", buffer, 5);
2187 StringToSwTraceStringTestHelper<SwTraceNameCharPolicy>("VALID_string_456", buffer, 6);
2188
2189 // Invalid SWTrace namestrings
2190 BOOST_CHECK(!StringToSwTraceString<SwTraceNameCharPolicy>(" ", buffer));
2191 BOOST_CHECK(buffer.empty());
2192 BOOST_CHECK(!StringToSwTraceString<SwTraceNameCharPolicy>("invalid string", buffer));
2193 BOOST_CHECK(buffer.empty());
2194 BOOST_CHECK(!StringToSwTraceString<SwTraceNameCharPolicy>("!$%", buffer));
2195 BOOST_CHECK(buffer.empty());
2196 BOOST_CHECK(!StringToSwTraceString<SwTraceNameCharPolicy>("invalid|\\~string#123", buffer));
2197 BOOST_CHECK(buffer.empty());
2198 BOOST_CHECK(!StringToSwTraceString<SwTraceNameCharPolicy>("€£", buffer));
2199 BOOST_CHECK(buffer.empty());
2200 BOOST_CHECK(!StringToSwTraceString<SwTraceNameCharPolicy>("invalid‡string", buffer));
2201 BOOST_CHECK(buffer.empty());
2202 BOOST_CHECK(!StringToSwTraceString<SwTraceNameCharPolicy>("12Ž34", buffer));
2203 BOOST_CHECK(buffer.empty());
2204}
2205
Francis Murtaghfcb8ef62019-09-20 15:40:09 +01002206BOOST_AUTO_TEST_CASE(CheckPeriodicCounterCaptureThread)
2207{
Matteo Martincighe0e6efc2019-10-04 17:17:42 +01002208 class CaptureReader : public IReadCounterValues
Francis Murtaghfcb8ef62019-09-20 15:40:09 +01002209 {
2210 public:
Finn Williamsf4d59a62019-10-14 15:55:18 +01002211 CaptureReader(uint16_t counterSize)
2212 {
Keith Davis3201eea2019-10-24 17:30:41 +01002213 for (uint16_t i = 0; i < counterSize; ++i)
Finn Williamsf4d59a62019-10-14 15:55:18 +01002214 {
2215 m_Data[i] = 0;
2216 }
2217 m_CounterSize = counterSize;
2218 }
2219 //not used
Matteo Martincighe8485382019-10-10 14:08:21 +01002220 bool IsCounterRegistered(uint16_t counterUid) const override
2221 {
Jan Eilers8eb25602020-03-09 12:13:48 +00002222 armnn::IgnoreUnused(counterUid);
Finn Williamsf4d59a62019-10-14 15:55:18 +01002223 return false;
Matteo Martincighe8485382019-10-10 14:08:21 +01002224 }
2225
Matteo Martincighe0e6efc2019-10-04 17:17:42 +01002226 uint16_t GetCounterCount() const override
Francis Murtaghfcb8ef62019-09-20 15:40:09 +01002227 {
Finn Williamsf4d59a62019-10-14 15:55:18 +01002228 return m_CounterSize;
Matteo Martincighe0e6efc2019-10-04 17:17:42 +01002229 }
2230
Matteo Martincighe8485382019-10-10 14:08:21 +01002231 uint32_t GetCounterValue(uint16_t counterUid) const override
Matteo Martincighe0e6efc2019-10-04 17:17:42 +01002232 {
Keith Davis3201eea2019-10-24 17:30:41 +01002233 if (counterUid > m_CounterSize)
Francis Murtaghfcb8ef62019-09-20 15:40:09 +01002234 {
Finn Williamsf4d59a62019-10-14 15:55:18 +01002235 BOOST_FAIL("Invalid counter Uid");
Francis Murtaghfcb8ef62019-09-20 15:40:09 +01002236 }
Matteo Martincighe8485382019-10-10 14:08:21 +01002237 return m_Data.at(counterUid).load();
Francis Murtaghfcb8ef62019-09-20 15:40:09 +01002238 }
2239
Matteo Martincighe8485382019-10-10 14:08:21 +01002240 void SetCounterValue(uint16_t counterUid, uint32_t value)
Francis Murtaghfcb8ef62019-09-20 15:40:09 +01002241 {
Keith Davis3201eea2019-10-24 17:30:41 +01002242 if (counterUid > m_CounterSize)
Francis Murtaghfcb8ef62019-09-20 15:40:09 +01002243 {
Finn Williamsf4d59a62019-10-14 15:55:18 +01002244 BOOST_FAIL("Invalid counter Uid");
Francis Murtaghfcb8ef62019-09-20 15:40:09 +01002245 }
Finn Williamsf4d59a62019-10-14 15:55:18 +01002246 m_Data.at(counterUid).store(value);
Francis Murtaghfcb8ef62019-09-20 15:40:09 +01002247 }
2248
2249 private:
Matteo Martincighe8485382019-10-10 14:08:21 +01002250 std::unordered_map<uint16_t, std::atomic<uint32_t>> m_Data;
Finn Williamsf4d59a62019-10-14 15:55:18 +01002251 uint16_t m_CounterSize;
Francis Murtaghfcb8ef62019-09-20 15:40:09 +01002252 };
2253
Matteo Martincigh5d737fb2019-10-07 13:05:13 +01002254 ProfilingStateMachine profilingStateMachine;
2255
Finn Williams032bc742020-02-12 11:02:34 +00002256 const std::unordered_map<armnn::BackendId,
2257 std::shared_ptr<armnn::profiling::IBackendProfilingContext>> backendProfilingContext;
2258 CounterIdMap counterIdMap;
Francis Murtaghfcb8ef62019-09-20 15:40:09 +01002259 Holder data;
2260 std::vector<uint16_t> captureIds1 = { 0, 1 };
2261 std::vector<uint16_t> captureIds2;
2262
Narumol Prangnawarat404b2752019-09-24 17:23:16 +01002263 MockBufferManager mockBuffer(512);
Sadik Armagan3896b472020-02-10 12:24:15 +00002264 SendCounterPacket sendCounterPacket(mockBuffer);
2265 SendThread sendThread(profilingStateMachine, mockBuffer, sendCounterPacket);
Francis Murtaghfcb8ef62019-09-20 15:40:09 +01002266
2267 std::vector<uint16_t> counterIds;
Finn Williamsf4d59a62019-10-14 15:55:18 +01002268 CaptureReader captureReader(2);
Francis Murtaghfcb8ef62019-09-20 15:40:09 +01002269
Keith Davis3201eea2019-10-24 17:30:41 +01002270 unsigned int valueA = 10;
2271 unsigned int valueB = 15;
Francis Murtaghfcb8ef62019-09-20 15:40:09 +01002272 unsigned int numSteps = 5;
2273
Finn Williams032bc742020-02-12 11:02:34 +00002274 PeriodicCounterCapture periodicCounterCapture(std::ref(data), std::ref(sendCounterPacket), captureReader,
2275 counterIdMap, backendProfilingContext);
Francis Murtaghfcb8ef62019-09-20 15:40:09 +01002276
Matteo Martincighe0e6efc2019-10-04 17:17:42 +01002277 for (unsigned int i = 0; i < numSteps; ++i)
Francis Murtaghfcb8ef62019-09-20 15:40:09 +01002278 {
Finn Williams032bc742020-02-12 11:02:34 +00002279 data.SetCaptureData(1, captureIds1, {});
Francis Murtaghfcb8ef62019-09-20 15:40:09 +01002280 captureReader.SetCounterValue(0, valueA * (i + 1));
2281 captureReader.SetCounterValue(1, valueB * (i + 1));
2282
2283 periodicCounterCapture.Start();
Finn Williamsf4d59a62019-10-14 15:55:18 +01002284 periodicCounterCapture.Stop();
Francis Murtaghfcb8ef62019-09-20 15:40:09 +01002285 }
2286
Narumol Prangnawarat404b2752019-09-24 17:23:16 +01002287 auto buffer = mockBuffer.GetReadableBuffer();
Francis Murtaghfcb8ef62019-09-20 15:40:09 +01002288
2289 uint32_t headerWord0 = ReadUint32(buffer, 0);
2290 uint32_t headerWord1 = ReadUint32(buffer, 4);
2291
Jim Flynnfc365622019-12-04 10:07:20 +00002292 BOOST_TEST(((headerWord0 >> 26) & 0x0000003F) == 3); // packet family
Keith Davis3201eea2019-10-24 17:30:41 +01002293 BOOST_TEST(((headerWord0 >> 19) & 0x0000007F) == 0); // packet class
2294 BOOST_TEST(((headerWord0 >> 16) & 0x00000007) == 0); // packet type
Matteo Martincigh8d9590e2019-10-15 09:35:29 +01002295 BOOST_TEST(headerWord1 == 20);
Francis Murtaghfcb8ef62019-09-20 15:40:09 +01002296
Keith Davis3201eea2019-10-24 17:30:41 +01002297 uint32_t offset = 16;
Francis Murtaghfcb8ef62019-09-20 15:40:09 +01002298 uint16_t readIndex = ReadUint16(buffer, offset);
2299 BOOST_TEST(0 == readIndex);
2300
2301 offset += 2;
2302 uint32_t readValue = ReadUint32(buffer, offset);
2303 BOOST_TEST((valueA * numSteps) == readValue);
2304
2305 offset += 4;
2306 readIndex = ReadUint16(buffer, offset);
2307 BOOST_TEST(1 == readIndex);
2308
2309 offset += 2;
2310 readValue = ReadUint32(buffer, offset);
2311 BOOST_TEST((valueB * numSteps) == readValue);
2312}
2313
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002314BOOST_AUTO_TEST_CASE(RequestCounterDirectoryCommandHandlerTest1)
Narumol Prangnawarat48033692019-09-20 12:04:55 +01002315{
2316 using boost::numeric_cast;
2317
Jim Flynn397043f2019-10-17 17:37:10 +01002318 const uint32_t familyId = 0;
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002319 const uint32_t packetId = 3;
Keith Davis3201eea2019-10-24 17:30:41 +01002320 const uint32_t version = 1;
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002321 ProfilingStateMachine profilingStateMachine;
2322 CounterDirectory counterDirectory;
Matteo Martincigh9723d022019-11-13 10:56:41 +00002323 MockBufferManager mockBuffer1(1024);
Sadik Armagan3896b472020-02-10 12:24:15 +00002324 SendCounterPacket sendCounterPacket(mockBuffer1);
2325 SendThread sendThread(profilingStateMachine, mockBuffer1, sendCounterPacket);
Matteo Martincigh9723d022019-11-13 10:56:41 +00002326 MockBufferManager mockBuffer2(1024);
2327 SendTimelinePacket sendTimelinePacket(mockBuffer2);
Keith Davis3201eea2019-10-24 17:30:41 +01002328 RequestCounterDirectoryCommandHandler commandHandler(familyId, packetId, version, counterDirectory,
Matteo Martincigh9723d022019-11-13 10:56:41 +00002329 sendCounterPacket, sendTimelinePacket, profilingStateMachine);
Narumol Prangnawarat48033692019-09-20 12:04:55 +01002330
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002331 const uint32_t wrongPacketId = 47;
Keith Davis3201eea2019-10-24 17:30:41 +01002332 const uint32_t wrongHeader = (wrongPacketId & 0x000003FF) << 16;
Narumol Prangnawarat48033692019-09-20 12:04:55 +01002333
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002334 Packet wrongPacket(wrongHeader);
2335
2336 profilingStateMachine.TransitionToState(ProfilingState::Uninitialised);
Matteo Martincigh9723d022019-11-13 10:56:41 +00002337 BOOST_CHECK_THROW(commandHandler(wrongPacket), armnn::RuntimeException); // Wrong profiling state
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002338 profilingStateMachine.TransitionToState(ProfilingState::NotConnected);
Matteo Martincigh9723d022019-11-13 10:56:41 +00002339 BOOST_CHECK_THROW(commandHandler(wrongPacket), armnn::RuntimeException); // Wrong profiling state
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002340 profilingStateMachine.TransitionToState(ProfilingState::WaitingForAck);
Matteo Martincigh9723d022019-11-13 10:56:41 +00002341 BOOST_CHECK_THROW(commandHandler(wrongPacket), armnn::RuntimeException); // Wrong profiling state
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002342 profilingStateMachine.TransitionToState(ProfilingState::Active);
Matteo Martincigh9723d022019-11-13 10:56:41 +00002343 BOOST_CHECK_THROW(commandHandler(wrongPacket), armnn::InvalidArgumentException); // Wrong packet
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002344
2345 const uint32_t rightHeader = (packetId & 0x000003FF) << 16;
2346
2347 Packet rightPacket(rightHeader);
2348
Matteo Martincigh9723d022019-11-13 10:56:41 +00002349 BOOST_CHECK_NO_THROW(commandHandler(rightPacket)); // Right packet
Narumol Prangnawarat48033692019-09-20 12:04:55 +01002350
Matteo Martincigh9723d022019-11-13 10:56:41 +00002351 auto readBuffer1 = mockBuffer1.GetReadableBuffer();
Narumol Prangnawarat48033692019-09-20 12:04:55 +01002352
Matteo Martincigh9723d022019-11-13 10:56:41 +00002353 uint32_t header1Word0 = ReadUint32(readBuffer1, 0);
2354 uint32_t header1Word1 = ReadUint32(readBuffer1, 4);
Narumol Prangnawarat48033692019-09-20 12:04:55 +01002355
Matteo Martincigh9723d022019-11-13 10:56:41 +00002356 // Counter directory packet
2357 BOOST_TEST(((header1Word0 >> 26) & 0x0000003F) == 0); // packet family
2358 BOOST_TEST(((header1Word0 >> 16) & 0x000003FF) == 2); // packet id
2359 BOOST_TEST(header1Word1 == 24); // data length
Narumol Prangnawarat48033692019-09-20 12:04:55 +01002360
Matteo Martincigh9723d022019-11-13 10:56:41 +00002361 uint32_t bodyHeader1Word0 = ReadUint32(readBuffer1, 8);
2362 uint16_t deviceRecordCount = numeric_cast<uint16_t>(bodyHeader1Word0 >> 16);
2363 BOOST_TEST(deviceRecordCount == 0); // device_records_count
2364
2365 auto readBuffer2 = mockBuffer2.GetReadableBuffer();
2366
2367 uint32_t header2Word0 = ReadUint32(readBuffer2, 0);
2368 uint32_t header2Word1 = ReadUint32(readBuffer2, 4);
2369
2370 // Timeline message directory packet
2371 BOOST_TEST(((header2Word0 >> 26) & 0x0000003F) == 1); // packet family
2372 BOOST_TEST(((header2Word0 >> 16) & 0x000003FF) == 0); // packet id
2373 BOOST_TEST(header2Word1 == 419); // data length
Narumol Prangnawarat48033692019-09-20 12:04:55 +01002374}
2375
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002376BOOST_AUTO_TEST_CASE(RequestCounterDirectoryCommandHandlerTest2)
Narumol Prangnawarat48033692019-09-20 12:04:55 +01002377{
2378 using boost::numeric_cast;
2379
Jim Flynn397043f2019-10-17 17:37:10 +01002380 const uint32_t familyId = 0;
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002381 const uint32_t packetId = 3;
Keith Davis3201eea2019-10-24 17:30:41 +01002382 const uint32_t version = 1;
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002383 ProfilingStateMachine profilingStateMachine;
2384 CounterDirectory counterDirectory;
Matteo Martincigh9723d022019-11-13 10:56:41 +00002385 MockBufferManager mockBuffer1(1024);
Sadik Armagan3896b472020-02-10 12:24:15 +00002386 SendCounterPacket sendCounterPacket(mockBuffer1);
2387 SendThread sendThread(profilingStateMachine, mockBuffer1, sendCounterPacket);
Matteo Martincigh9723d022019-11-13 10:56:41 +00002388 MockBufferManager mockBuffer2(1024);
2389 SendTimelinePacket sendTimelinePacket(mockBuffer2);
Keith Davis3201eea2019-10-24 17:30:41 +01002390 RequestCounterDirectoryCommandHandler commandHandler(familyId, packetId, version, counterDirectory,
Matteo Martincigh9723d022019-11-13 10:56:41 +00002391 sendCounterPacket, sendTimelinePacket, profilingStateMachine);
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002392 const uint32_t header = (packetId & 0x000003FF) << 16;
2393 Packet packet(header);
Narumol Prangnawarat48033692019-09-20 12:04:55 +01002394
Matteo Martincigh9723d022019-11-13 10:56:41 +00002395 const Device* device = counterDirectory.RegisterDevice("deviceA", 1);
2396 BOOST_CHECK(device != nullptr);
Narumol Prangnawarat48033692019-09-20 12:04:55 +01002397 const CounterSet* counterSet = counterDirectory.RegisterCounterSet("countersetA");
Matteo Martincigh9723d022019-11-13 10:56:41 +00002398 BOOST_CHECK(counterSet != nullptr);
Sadik Armagan4c998992020-02-25 12:44:44 +00002399 counterDirectory.RegisterCategory("categoryA");
Keith Davise394bd92019-12-02 15:12:19 +00002400 counterDirectory.RegisterCounter(armnn::profiling::BACKEND_ID, 24,
2401 "categoryA", 0, 1, 2.0f, "counterA", "descA");
2402 counterDirectory.RegisterCounter(armnn::profiling::BACKEND_ID, 25,
2403 "categoryA", 1, 1, 3.0f, "counterB", "descB");
Narumol Prangnawarat48033692019-09-20 12:04:55 +01002404
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002405 profilingStateMachine.TransitionToState(ProfilingState::Uninitialised);
Keith Davis3201eea2019-10-24 17:30:41 +01002406 BOOST_CHECK_THROW(commandHandler(packet), armnn::RuntimeException); // Wrong profiling state
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002407 profilingStateMachine.TransitionToState(ProfilingState::NotConnected);
Keith Davis3201eea2019-10-24 17:30:41 +01002408 BOOST_CHECK_THROW(commandHandler(packet), armnn::RuntimeException); // Wrong profiling state
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002409 profilingStateMachine.TransitionToState(ProfilingState::WaitingForAck);
Keith Davis3201eea2019-10-24 17:30:41 +01002410 BOOST_CHECK_THROW(commandHandler(packet), armnn::RuntimeException); // Wrong profiling state
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002411 profilingStateMachine.TransitionToState(ProfilingState::Active);
2412 BOOST_CHECK_NO_THROW(commandHandler(packet));
Narumol Prangnawarat48033692019-09-20 12:04:55 +01002413
Matteo Martincigh9723d022019-11-13 10:56:41 +00002414 auto readBuffer1 = mockBuffer1.GetReadableBuffer();
Narumol Prangnawarat48033692019-09-20 12:04:55 +01002415
Matteo Martincigh9723d022019-11-13 10:56:41 +00002416 uint32_t header1Word0 = ReadUint32(readBuffer1, 0);
2417 uint32_t header1Word1 = ReadUint32(readBuffer1, 4);
Narumol Prangnawarat48033692019-09-20 12:04:55 +01002418
Matteo Martincigh9723d022019-11-13 10:56:41 +00002419 BOOST_TEST(((header1Word0 >> 26) & 0x0000003F) == 0); // packet family
2420 BOOST_TEST(((header1Word0 >> 16) & 0x000003FF) == 2); // packet id
Sadik Armagan4c998992020-02-25 12:44:44 +00002421 BOOST_TEST(header1Word1 == 236); // data length
Narumol Prangnawarat48033692019-09-20 12:04:55 +01002422
Matteo Martincigh9723d022019-11-13 10:56:41 +00002423 uint32_t bodyHeader1Word0 = ReadUint32(readBuffer1, 8);
2424 uint32_t bodyHeader1Word1 = ReadUint32(readBuffer1, 12);
2425 uint32_t bodyHeader1Word2 = ReadUint32(readBuffer1, 16);
2426 uint32_t bodyHeader1Word3 = ReadUint32(readBuffer1, 20);
2427 uint32_t bodyHeader1Word4 = ReadUint32(readBuffer1, 24);
2428 uint32_t bodyHeader1Word5 = ReadUint32(readBuffer1, 28);
2429 uint16_t deviceRecordCount = numeric_cast<uint16_t>(bodyHeader1Word0 >> 16);
2430 uint16_t counterSetRecordCount = numeric_cast<uint16_t>(bodyHeader1Word2 >> 16);
2431 uint16_t categoryRecordCount = numeric_cast<uint16_t>(bodyHeader1Word4 >> 16);
2432 BOOST_TEST(deviceRecordCount == 1); // device_records_count
2433 BOOST_TEST(bodyHeader1Word1 == 0); // device_records_pointer_table_offset
2434 BOOST_TEST(counterSetRecordCount == 1); // counter_set_count
2435 BOOST_TEST(bodyHeader1Word3 == 4); // counter_set_pointer_table_offset
2436 BOOST_TEST(categoryRecordCount == 1); // categories_count
2437 BOOST_TEST(bodyHeader1Word5 == 8); // categories_pointer_table_offset
Narumol Prangnawarat48033692019-09-20 12:04:55 +01002438
Matteo Martincigh9723d022019-11-13 10:56:41 +00002439 uint32_t deviceRecordOffset = ReadUint32(readBuffer1, 32);
Keith Davis3201eea2019-10-24 17:30:41 +01002440 BOOST_TEST(deviceRecordOffset == 0);
Narumol Prangnawarat48033692019-09-20 12:04:55 +01002441
Matteo Martincigh9723d022019-11-13 10:56:41 +00002442 uint32_t counterSetRecordOffset = ReadUint32(readBuffer1, 36);
Narumol Prangnawarat48033692019-09-20 12:04:55 +01002443 BOOST_TEST(counterSetRecordOffset == 20);
2444
Matteo Martincigh9723d022019-11-13 10:56:41 +00002445 uint32_t categoryRecordOffset = ReadUint32(readBuffer1, 40);
Keith Davis3201eea2019-10-24 17:30:41 +01002446 BOOST_TEST(categoryRecordOffset == 44);
Matteo Martincigh9723d022019-11-13 10:56:41 +00002447
2448 auto readBuffer2 = mockBuffer2.GetReadableBuffer();
2449
2450 uint32_t header2Word0 = ReadUint32(readBuffer2, 0);
2451 uint32_t header2Word1 = ReadUint32(readBuffer2, 4);
2452
2453 // Timeline message directory packet
2454 BOOST_TEST(((header2Word0 >> 26) & 0x0000003F) == 1); // packet family
2455 BOOST_TEST(((header2Word0 >> 16) & 0x000003FF) == 0); // packet id
2456 BOOST_TEST(header2Word1 == 419); // data length
Narumol Prangnawarat48033692019-09-20 12:04:55 +01002457}
2458
Matteo Martincigh54fb9572019-10-02 12:50:57 +01002459BOOST_AUTO_TEST_CASE(CheckProfilingServiceGoodConnectionAcknowledgedPacket)
2460{
Finn Williamsa0de0562020-04-22 12:27:37 +01002461 unsigned int streamMetadataPacketsize = GetStreamMetaDataPacketSize();
Matteo Martincigh54fb9572019-10-02 12:50:57 +01002462
Jim Flynn53e46992019-10-14 12:31:10 +01002463 // Reset the profiling service to the uninitialized state
Matteo Martincigh54fb9572019-10-02 12:50:57 +01002464 armnn::Runtime::CreationOptions::ExternalProfilingOptions options;
Keith Davis3201eea2019-10-24 17:30:41 +01002465 options.m_EnableProfiling = true;
Sadik Armagan3184c902020-03-18 10:57:30 +00002466 armnn::profiling::ProfilingService profilingService;
Matteo Martincigh54fb9572019-10-02 12:50:57 +01002467 profilingService.ResetExternalProfilingOptions(options, true);
2468
Sadik Armagan3184c902020-03-18 10:57:30 +00002469 // Swap the profiling connection factory in the profiling service instance with our mock one
2470 SwapProfilingConnectionFactoryHelper helper(profilingService);
2471
Matteo Martincigh54fb9572019-10-02 12:50:57 +01002472 // Bring the profiling service to the "WaitingForAck" state
2473 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Uninitialised);
Keith Davis3201eea2019-10-24 17:30:41 +01002474 profilingService.Update(); // Initialize the counter directory
Matteo Martincigh54fb9572019-10-02 12:50:57 +01002475 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::NotConnected);
Keith Davis3201eea2019-10-24 17:30:41 +01002476 profilingService.Update(); // Create the profiling connection
Matteo Martincigh54fb9572019-10-02 12:50:57 +01002477
Matteo Martincighd0613b52019-10-09 16:47:04 +01002478 // Get the mock profiling connection
2479 MockProfilingConnection* mockProfilingConnection = helper.GetMockProfilingConnection();
2480 BOOST_CHECK(mockProfilingConnection);
2481
Matteo Martincighe8485382019-10-10 14:08:21 +01002482 // Remove the packets received so far
2483 mockProfilingConnection->Clear();
2484
2485 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::WaitingForAck);
Keith Davis3201eea2019-10-24 17:30:41 +01002486 profilingService.Update(); // Start the command handler and the send thread
Matteo Martincighe8485382019-10-10 14:08:21 +01002487
2488 // Wait for the Stream Metadata packet to be sent
Finn Williams09ad6f92019-12-19 17:05:18 +00002489 BOOST_CHECK(helper.WaitForPacketsSent(
2490 mockProfilingConnection, PacketType::StreamMetaData, streamMetadataPacketsize) >= 1);
Matteo Martincigh54fb9572019-10-02 12:50:57 +01002491
2492 // Write a valid "Connection Acknowledged" packet into the mock profiling connection, to simulate a valid
2493 // reply from an external profiling service
2494
2495 // Connection Acknowledged Packet header (word 0, word 1 is always zero):
2496 // 26:31 [6] packet_family: Control Packet Family, value 0b000000
2497 // 16:25 [10] packet_id: Packet identifier, value 0b0000000001
2498 // 8:15 [8] reserved: Reserved, value 0b00000000
2499 // 0:7 [8] reserved: Reserved, value 0b00000000
2500 uint32_t packetFamily = 0;
2501 uint32_t packetId = 1;
Keith Davis3201eea2019-10-24 17:30:41 +01002502 uint32_t header = ((packetFamily & 0x0000003F) << 26) | ((packetId & 0x000003FF) << 16);
Matteo Martincigh54fb9572019-10-02 12:50:57 +01002503
Matteo Martincighd0613b52019-10-09 16:47:04 +01002504 // Create the Connection Acknowledged Packet
Matteo Martincigh54fb9572019-10-02 12:50:57 +01002505 Packet connectionAcknowledgedPacket(header);
2506
2507 // Write the packet to the mock profiling connection
2508 mockProfilingConnection->WritePacket(std::move(connectionAcknowledgedPacket));
2509
Colm Donelan2ba48d22019-11-29 09:10:59 +00002510 // Wait for the counter directory packet to ensure the ConnectionAcknowledgedCommandHandler has run.
Finn Williams09ad6f92019-12-19 17:05:18 +00002511 BOOST_CHECK(helper.WaitForPacketsSent(mockProfilingConnection, PacketType::CounterDirectory) == 1);
Matteo Martincigh54fb9572019-10-02 12:50:57 +01002512
2513 // The Connection Acknowledged Command Handler should have updated the profiling state accordingly
2514 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Active);
Matteo Martincighd0613b52019-10-09 16:47:04 +01002515
2516 // Reset the profiling service to stop any running thread
2517 options.m_EnableProfiling = false;
2518 profilingService.ResetExternalProfilingOptions(options, true);
Matteo Martincigh54fb9572019-10-02 12:50:57 +01002519}
2520
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002521BOOST_AUTO_TEST_CASE(CheckProfilingServiceGoodRequestCounterDirectoryPacket)
2522{
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002523 // Reset the profiling service to the uninitialized state
2524 armnn::Runtime::CreationOptions::ExternalProfilingOptions options;
Keith Davis3201eea2019-10-24 17:30:41 +01002525 options.m_EnableProfiling = true;
Sadik Armagan3184c902020-03-18 10:57:30 +00002526 armnn::profiling::ProfilingService profilingService;
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002527 profilingService.ResetExternalProfilingOptions(options, true);
2528
Sadik Armagan3184c902020-03-18 10:57:30 +00002529 // Swap the profiling connection factory in the profiling service instance with our mock one
2530 SwapProfilingConnectionFactoryHelper helper(profilingService);
2531
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002532 // Bring the profiling service to the "Active" state
2533 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Uninitialised);
Keith Davis3201eea2019-10-24 17:30:41 +01002534 profilingService.Update(); // Initialize the counter directory
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002535 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::NotConnected);
Keith Davis3201eea2019-10-24 17:30:41 +01002536 profilingService.Update(); // Create the profiling connection
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002537 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::WaitingForAck);
Keith Davis3201eea2019-10-24 17:30:41 +01002538 profilingService.Update(); // Start the command handler and the send thread
Matteo Martincighe8485382019-10-10 14:08:21 +01002539
Colm Donelan2ba48d22019-11-29 09:10:59 +00002540 // Get the mock profiling connection
2541 MockProfilingConnection* mockProfilingConnection = helper.GetMockProfilingConnection();
2542 BOOST_CHECK(mockProfilingConnection);
2543
Matteo Martincighe8485382019-10-10 14:08:21 +01002544 // Force the profiling service to the "Active" state
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002545 helper.ForceTransitionToState(ProfilingState::Active);
2546 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Active);
2547
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002548 // Write a valid "Request Counter Directory" packet into the mock profiling connection, to simulate a valid
2549 // reply from an external profiling service
2550
2551 // Request Counter Directory packet header (word 0, word 1 is always zero):
2552 // 26:31 [6] packet_family: Control Packet Family, value 0b000000
2553 // 16:25 [10] packet_id: Packet identifier, value 0b0000000011
2554 // 8:15 [8] reserved: Reserved, value 0b00000000
2555 // 0:7 [8] reserved: Reserved, value 0b00000000
2556 uint32_t packetFamily = 0;
2557 uint32_t packetId = 3;
Keith Davis3201eea2019-10-24 17:30:41 +01002558 uint32_t header = ((packetFamily & 0x0000003F) << 26) | ((packetId & 0x000003FF) << 16);
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002559
2560 // Create the Request Counter Directory packet
2561 Packet requestCounterDirectoryPacket(header);
2562
2563 // Write the packet to the mock profiling connection
2564 mockProfilingConnection->WritePacket(std::move(requestCounterDirectoryPacket));
2565
Sadik Armagan4c998992020-02-25 12:44:44 +00002566 // Expecting one CounterDirectory Packet of length 652
Finn Williams09ad6f92019-12-19 17:05:18 +00002567 // and one TimelineMessageDirectory packet of length 427
Sadik Armagan4c998992020-02-25 12:44:44 +00002568 BOOST_CHECK(helper.WaitForPacketsSent(mockProfilingConnection, PacketType::CounterDirectory, 652) == 1);
Finn Williams09ad6f92019-12-19 17:05:18 +00002569 BOOST_CHECK(helper.WaitForPacketsSent(mockProfilingConnection, PacketType::TimelineMessageDirectory, 427) == 1);
Matteo Martincighe8485382019-10-10 14:08:21 +01002570
2571 // The Request Counter Directory Command Handler should not have updated the profiling state
2572 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Active);
2573
2574 // Reset the profiling service to stop any running thread
2575 options.m_EnableProfiling = false;
2576 profilingService.ResetExternalProfilingOptions(options, true);
2577}
2578
Matteo Martincighe8485382019-10-10 14:08:21 +01002579BOOST_AUTO_TEST_CASE(CheckProfilingServiceBadPeriodicCounterSelectionPacketInvalidCounterUid)
2580{
Matteo Martincighe8485382019-10-10 14:08:21 +01002581 // Reset the profiling service to the uninitialized state
2582 armnn::Runtime::CreationOptions::ExternalProfilingOptions options;
Keith Davis3201eea2019-10-24 17:30:41 +01002583 options.m_EnableProfiling = true;
Sadik Armagan3184c902020-03-18 10:57:30 +00002584 armnn::profiling::ProfilingService profilingService;
Matteo Martincighe8485382019-10-10 14:08:21 +01002585 profilingService.ResetExternalProfilingOptions(options, true);
2586
Sadik Armagan3184c902020-03-18 10:57:30 +00002587 // Swap the profiling connection factory in the profiling service instance with our mock one
2588 SwapProfilingConnectionFactoryHelper helper(profilingService);
2589
Matteo Martincighe8485382019-10-10 14:08:21 +01002590 // Bring the profiling service to the "Active" state
2591 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Uninitialised);
Keith Davis3201eea2019-10-24 17:30:41 +01002592 profilingService.Update(); // Initialize the counter directory
Matteo Martincighe8485382019-10-10 14:08:21 +01002593 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::NotConnected);
Keith Davis3201eea2019-10-24 17:30:41 +01002594 profilingService.Update(); // Create the profiling connection
Matteo Martincighe8485382019-10-10 14:08:21 +01002595 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::WaitingForAck);
Keith Davis3201eea2019-10-24 17:30:41 +01002596 profilingService.Update(); // Start the command handler and the send thread
Matteo Martincighe8485382019-10-10 14:08:21 +01002597
Colm Donelan2ba48d22019-11-29 09:10:59 +00002598 // Get the mock profiling connection
2599 MockProfilingConnection* mockProfilingConnection = helper.GetMockProfilingConnection();
2600 BOOST_CHECK(mockProfilingConnection);
2601
Matteo Martincighe8485382019-10-10 14:08:21 +01002602 // Force the profiling service to the "Active" state
2603 helper.ForceTransitionToState(ProfilingState::Active);
2604 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Active);
2605
Matteo Martincighe8485382019-10-10 14:08:21 +01002606 // Remove the packets received so far
2607 mockProfilingConnection->Clear();
2608
2609 // Write a "Periodic Counter Selection" packet into the mock profiling connection, to simulate an input from an
2610 // external profiling service
2611
2612 // Periodic Counter Selection packet header:
2613 // 26:31 [6] packet_family: Control Packet Family, value 0b000000
2614 // 16:25 [10] packet_id: Packet identifier, value 0b0000000100
2615 // 8:15 [8] reserved: Reserved, value 0b00000000
2616 // 0:7 [8] reserved: Reserved, value 0b00000000
2617 uint32_t packetFamily = 0;
2618 uint32_t packetId = 4;
Keith Davis3201eea2019-10-24 17:30:41 +01002619 uint32_t header = ((packetFamily & 0x0000003F) << 26) | ((packetId & 0x000003FF) << 16);
Matteo Martincighe8485382019-10-10 14:08:21 +01002620
Keith Davis3201eea2019-10-24 17:30:41 +01002621 uint32_t capturePeriod = 123456; // Some capture period (microseconds)
Matteo Martincighe8485382019-10-10 14:08:21 +01002622
2623 // Get the first valid counter UID
2624 const ICounterDirectory& counterDirectory = profilingService.GetCounterDirectory();
Keith Davis3201eea2019-10-24 17:30:41 +01002625 const Counters& counters = counterDirectory.GetCounters();
Matteo Martincighe8485382019-10-10 14:08:21 +01002626 BOOST_CHECK(counters.size() > 1);
Keith Davis3201eea2019-10-24 17:30:41 +01002627 uint16_t counterUidA = counters.begin()->first; // First valid counter UID
2628 uint16_t counterUidB = 9999; // Second invalid counter UID
Matteo Martincighe8485382019-10-10 14:08:21 +01002629
2630 uint32_t length = 8;
2631
2632 auto data = std::make_unique<unsigned char[]>(length);
2633 WriteUint32(data.get(), 0, capturePeriod);
2634 WriteUint16(data.get(), 4, counterUidA);
2635 WriteUint16(data.get(), 6, counterUidB);
2636
2637 // Create the Periodic Counter Selection packet
Keith Davis3201eea2019-10-24 17:30:41 +01002638 Packet periodicCounterSelectionPacket(header, length, data); // Length > 0, this will start the Period Counter
2639 // Capture thread
Matteo Martincighe8485382019-10-10 14:08:21 +01002640
2641 // Write the packet to the mock profiling connection
2642 mockProfilingConnection->WritePacket(std::move(periodicCounterSelectionPacket));
2643
Finn Williams09ad6f92019-12-19 17:05:18 +00002644 // Expecting one Periodic Counter Selection packet of length 14
2645 // and at least one Periodic Counter Capture packet of length 22
2646 BOOST_CHECK(helper.WaitForPacketsSent(mockProfilingConnection, PacketType::PeriodicCounterSelection, 14) == 1);
2647 BOOST_CHECK(helper.WaitForPacketsSent(mockProfilingConnection, PacketType::PeriodicCounterCapture, 22) >= 1);
Matteo Martincighe8485382019-10-10 14:08:21 +01002648
2649 // The Periodic Counter Selection Handler should not have updated the profiling state
2650 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Active);
2651
2652 // Reset the profiling service to stop any running thread
2653 options.m_EnableProfiling = false;
2654 profilingService.ResetExternalProfilingOptions(options, true);
2655}
2656
2657BOOST_AUTO_TEST_CASE(CheckProfilingServiceGoodPeriodicCounterSelectionPacketNoCounters)
2658{
Matteo Martincighe8485382019-10-10 14:08:21 +01002659 // Reset the profiling service to the uninitialized state
2660 armnn::Runtime::CreationOptions::ExternalProfilingOptions options;
Keith Davis3201eea2019-10-24 17:30:41 +01002661 options.m_EnableProfiling = true;
Sadik Armagan3184c902020-03-18 10:57:30 +00002662 armnn::profiling::ProfilingService profilingService;
Matteo Martincighe8485382019-10-10 14:08:21 +01002663 profilingService.ResetExternalProfilingOptions(options, true);
2664
Sadik Armagan3184c902020-03-18 10:57:30 +00002665 // Swap the profiling connection factory in the profiling service instance with our mock one
2666 SwapProfilingConnectionFactoryHelper helper(profilingService);
2667
Matteo Martincighe8485382019-10-10 14:08:21 +01002668 // Bring the profiling service to the "Active" state
2669 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Uninitialised);
Keith Davis3201eea2019-10-24 17:30:41 +01002670 profilingService.Update(); // Initialize the counter directory
Matteo Martincighe8485382019-10-10 14:08:21 +01002671 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::NotConnected);
Keith Davis3201eea2019-10-24 17:30:41 +01002672 profilingService.Update(); // Create the profiling connection
Matteo Martincighe8485382019-10-10 14:08:21 +01002673 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::WaitingForAck);
Keith Davis3201eea2019-10-24 17:30:41 +01002674 profilingService.Update(); // Start the command handler and the send thread
Matteo Martincighe8485382019-10-10 14:08:21 +01002675
Colm Donelan2ba48d22019-11-29 09:10:59 +00002676 // Get the mock profiling connection
2677 MockProfilingConnection* mockProfilingConnection = helper.GetMockProfilingConnection();
2678 BOOST_CHECK(mockProfilingConnection);
2679
Matteo Martincighe8485382019-10-10 14:08:21 +01002680 // Wait for the Stream Metadata packet the be sent
2681 // (we are not testing the connection acknowledgement here so it will be ignored by this test)
Finn Williams09ad6f92019-12-19 17:05:18 +00002682 helper.WaitForPacketsSent(mockProfilingConnection, PacketType::StreamMetaData);
Matteo Martincighe8485382019-10-10 14:08:21 +01002683
2684 // Force the profiling service to the "Active" state
2685 helper.ForceTransitionToState(ProfilingState::Active);
2686 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Active);
2687
Matteo Martincighe8485382019-10-10 14:08:21 +01002688 // Write a "Periodic Counter Selection" packet into the mock profiling connection, to simulate an input from an
2689 // external profiling service
2690
2691 // Periodic Counter Selection packet header:
2692 // 26:31 [6] packet_family: Control Packet Family, value 0b000000
2693 // 16:25 [10] packet_id: Packet identifier, value 0b0000000100
2694 // 8:15 [8] reserved: Reserved, value 0b00000000
2695 // 0:7 [8] reserved: Reserved, value 0b00000000
2696 uint32_t packetFamily = 0;
2697 uint32_t packetId = 4;
Keith Davis3201eea2019-10-24 17:30:41 +01002698 uint32_t header = ((packetFamily & 0x0000003F) << 26) | ((packetId & 0x000003FF) << 16);
Matteo Martincighe8485382019-10-10 14:08:21 +01002699
2700 // Create the Periodic Counter Selection packet
Keith Davis3201eea2019-10-24 17:30:41 +01002701 Packet periodicCounterSelectionPacket(header); // Length == 0, this will disable the collection of counters
Matteo Martincighe8485382019-10-10 14:08:21 +01002702
2703 // Write the packet to the mock profiling connection
2704 mockProfilingConnection->WritePacket(std::move(periodicCounterSelectionPacket));
2705
Finn Williams09ad6f92019-12-19 17:05:18 +00002706 // Wait for the Periodic Counter Selection packet of length 12 to be sent
2707 // The size of the expected Periodic Counter Selection (echos the sent one)
2708 BOOST_CHECK(helper.WaitForPacketsSent(mockProfilingConnection, PacketType::PeriodicCounterSelection, 12) == 1);
Matteo Martincighe8485382019-10-10 14:08:21 +01002709
2710 // The Periodic Counter Selection Handler should not have updated the profiling state
2711 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Active);
2712
Finn Williams09ad6f92019-12-19 17:05:18 +00002713 // No Periodic Counter packets are expected
2714 BOOST_CHECK(helper.WaitForPacketsSent(mockProfilingConnection, PacketType::PeriodicCounterCapture, 0, 0) == 0);
Matteo Martincighe8485382019-10-10 14:08:21 +01002715
2716 // Reset the profiling service to stop any running thread
2717 options.m_EnableProfiling = false;
2718 profilingService.ResetExternalProfilingOptions(options, true);
2719}
2720
2721BOOST_AUTO_TEST_CASE(CheckProfilingServiceGoodPeriodicCounterSelectionPacketSingleCounter)
2722{
Matteo Martincighe8485382019-10-10 14:08:21 +01002723 // Reset the profiling service to the uninitialized state
2724 armnn::Runtime::CreationOptions::ExternalProfilingOptions options;
Keith Davis3201eea2019-10-24 17:30:41 +01002725 options.m_EnableProfiling = true;
Sadik Armagan3184c902020-03-18 10:57:30 +00002726 armnn::profiling::ProfilingService profilingService;
Matteo Martincighe8485382019-10-10 14:08:21 +01002727 profilingService.ResetExternalProfilingOptions(options, true);
2728
Sadik Armagan3184c902020-03-18 10:57:30 +00002729 // Swap the profiling connection factory in the profiling service instance with our mock one
2730 SwapProfilingConnectionFactoryHelper helper(profilingService);
2731
Matteo Martincighe8485382019-10-10 14:08:21 +01002732 // Bring the profiling service to the "Active" state
2733 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Uninitialised);
Keith Davis3201eea2019-10-24 17:30:41 +01002734 profilingService.Update(); // Initialize the counter directory
Matteo Martincighe8485382019-10-10 14:08:21 +01002735 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::NotConnected);
Keith Davis3201eea2019-10-24 17:30:41 +01002736 profilingService.Update(); // Create the profiling connection
Matteo Martincighe8485382019-10-10 14:08:21 +01002737 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::WaitingForAck);
Keith Davis3201eea2019-10-24 17:30:41 +01002738 profilingService.Update(); // Start the command handler and the send thread
Matteo Martincighe8485382019-10-10 14:08:21 +01002739
Colm Donelan2ba48d22019-11-29 09:10:59 +00002740 // Get the mock profiling connection
2741 MockProfilingConnection* mockProfilingConnection = helper.GetMockProfilingConnection();
2742 BOOST_CHECK(mockProfilingConnection);
2743
Finn Williams09ad6f92019-12-19 17:05:18 +00002744 // Wait for the Stream Metadata packet to be sent
Matteo Martincighe8485382019-10-10 14:08:21 +01002745 // (we are not testing the connection acknowledgement here so it will be ignored by this test)
Finn Williams09ad6f92019-12-19 17:05:18 +00002746 helper.WaitForPacketsSent(mockProfilingConnection, PacketType::StreamMetaData);
Matteo Martincighe8485382019-10-10 14:08:21 +01002747
2748 // Force the profiling service to the "Active" state
2749 helper.ForceTransitionToState(ProfilingState::Active);
2750 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Active);
2751
Matteo Martincighe8485382019-10-10 14:08:21 +01002752 // Write a "Periodic Counter Selection" packet into the mock profiling connection, to simulate an input from an
2753 // external profiling service
2754
2755 // Periodic Counter Selection packet header:
2756 // 26:31 [6] packet_family: Control Packet Family, value 0b000000
2757 // 16:25 [10] packet_id: Packet identifier, value 0b0000000100
2758 // 8:15 [8] reserved: Reserved, value 0b00000000
2759 // 0:7 [8] reserved: Reserved, value 0b00000000
2760 uint32_t packetFamily = 0;
2761 uint32_t packetId = 4;
Keith Davis3201eea2019-10-24 17:30:41 +01002762 uint32_t header = ((packetFamily & 0x0000003F) << 26) | ((packetId & 0x000003FF) << 16);
Matteo Martincighe8485382019-10-10 14:08:21 +01002763
Keith Davis3201eea2019-10-24 17:30:41 +01002764 uint32_t capturePeriod = 123456; // Some capture period (microseconds)
Matteo Martincighe8485382019-10-10 14:08:21 +01002765
2766 // Get the first valid counter UID
2767 const ICounterDirectory& counterDirectory = profilingService.GetCounterDirectory();
Keith Davis3201eea2019-10-24 17:30:41 +01002768 const Counters& counters = counterDirectory.GetCounters();
Matteo Martincighe8485382019-10-10 14:08:21 +01002769 BOOST_CHECK(!counters.empty());
Keith Davis3201eea2019-10-24 17:30:41 +01002770 uint16_t counterUid = counters.begin()->first; // Valid counter UID
Matteo Martincighe8485382019-10-10 14:08:21 +01002771
2772 uint32_t length = 6;
2773
2774 auto data = std::make_unique<unsigned char[]>(length);
2775 WriteUint32(data.get(), 0, capturePeriod);
2776 WriteUint16(data.get(), 4, counterUid);
2777
2778 // Create the Periodic Counter Selection packet
Keith Davis3201eea2019-10-24 17:30:41 +01002779 Packet periodicCounterSelectionPacket(header, length, data); // Length > 0, this will start the Period Counter
2780 // Capture thread
Matteo Martincighe8485382019-10-10 14:08:21 +01002781
2782 // Write the packet to the mock profiling connection
2783 mockProfilingConnection->WritePacket(std::move(periodicCounterSelectionPacket));
2784
Finn Williams09ad6f92019-12-19 17:05:18 +00002785 // Expecting one Periodic Counter Selection packet of length 14
2786 // and at least one Periodic Counter Capture packet of length 22
2787 BOOST_CHECK(helper.WaitForPacketsSent(mockProfilingConnection, PacketType::PeriodicCounterSelection, 14) == 1);
2788 BOOST_CHECK(helper.WaitForPacketsSent(mockProfilingConnection, PacketType::PeriodicCounterCapture, 22) >= 1);
Matteo Martincighe8485382019-10-10 14:08:21 +01002789
2790 // The Periodic Counter Selection Handler should not have updated the profiling state
2791 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Active);
2792
2793 // Reset the profiling service to stop any running thread
2794 options.m_EnableProfiling = false;
2795 profilingService.ResetExternalProfilingOptions(options, true);
2796}
2797
2798BOOST_AUTO_TEST_CASE(CheckProfilingServiceGoodPeriodicCounterSelectionPacketMultipleCounters)
2799{
Matteo Martincighe8485382019-10-10 14:08:21 +01002800 // Reset the profiling service to the uninitialized state
2801 armnn::Runtime::CreationOptions::ExternalProfilingOptions options;
Keith Davis3201eea2019-10-24 17:30:41 +01002802 options.m_EnableProfiling = true;
Sadik Armagan3184c902020-03-18 10:57:30 +00002803 armnn::profiling::ProfilingService profilingService;
Matteo Martincighe8485382019-10-10 14:08:21 +01002804 profilingService.ResetExternalProfilingOptions(options, true);
2805
Sadik Armagan3184c902020-03-18 10:57:30 +00002806 // Swap the profiling connection factory in the profiling service instance with our mock one
2807 SwapProfilingConnectionFactoryHelper helper(profilingService);
2808
Matteo Martincighe8485382019-10-10 14:08:21 +01002809 // Bring the profiling service to the "Active" state
2810 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Uninitialised);
Keith Davis3201eea2019-10-24 17:30:41 +01002811 profilingService.Update(); // Initialize the counter directory
Matteo Martincighe8485382019-10-10 14:08:21 +01002812 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::NotConnected);
Keith Davis3201eea2019-10-24 17:30:41 +01002813 profilingService.Update(); // Create the profiling connection
Matteo Martincighe8485382019-10-10 14:08:21 +01002814 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::WaitingForAck);
Keith Davis3201eea2019-10-24 17:30:41 +01002815 profilingService.Update(); // Start the command handler and the send thread
Matteo Martincighe8485382019-10-10 14:08:21 +01002816
Colm Donelan2ba48d22019-11-29 09:10:59 +00002817 // Get the mock profiling connection
2818 MockProfilingConnection* mockProfilingConnection = helper.GetMockProfilingConnection();
2819 BOOST_CHECK(mockProfilingConnection);
2820
Matteo Martincighe8485382019-10-10 14:08:21 +01002821 // Wait for the Stream Metadata packet the be sent
2822 // (we are not testing the connection acknowledgement here so it will be ignored by this test)
Finn Williams09ad6f92019-12-19 17:05:18 +00002823 helper.WaitForPacketsSent(mockProfilingConnection, PacketType::StreamMetaData);
Matteo Martincighe8485382019-10-10 14:08:21 +01002824
2825 // Force the profiling service to the "Active" state
2826 helper.ForceTransitionToState(ProfilingState::Active);
2827 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Active);
2828
Matteo Martincighe8485382019-10-10 14:08:21 +01002829 // Write a "Periodic Counter Selection" packet into the mock profiling connection, to simulate an input from an
2830 // external profiling service
2831
2832 // Periodic Counter Selection packet header:
2833 // 26:31 [6] packet_family: Control Packet Family, value 0b000000
2834 // 16:25 [10] packet_id: Packet identifier, value 0b0000000100
2835 // 8:15 [8] reserved: Reserved, value 0b00000000
2836 // 0:7 [8] reserved: Reserved, value 0b00000000
2837 uint32_t packetFamily = 0;
2838 uint32_t packetId = 4;
Keith Davis3201eea2019-10-24 17:30:41 +01002839 uint32_t header = ((packetFamily & 0x0000003F) << 26) | ((packetId & 0x000003FF) << 16);
Matteo Martincighe8485382019-10-10 14:08:21 +01002840
Keith Davis3201eea2019-10-24 17:30:41 +01002841 uint32_t capturePeriod = 123456; // Some capture period (microseconds)
Matteo Martincighe8485382019-10-10 14:08:21 +01002842
2843 // Get the first valid counter UID
2844 const ICounterDirectory& counterDirectory = profilingService.GetCounterDirectory();
Keith Davis3201eea2019-10-24 17:30:41 +01002845 const Counters& counters = counterDirectory.GetCounters();
Matteo Martincighe8485382019-10-10 14:08:21 +01002846 BOOST_CHECK(counters.size() > 1);
Keith Davis3201eea2019-10-24 17:30:41 +01002847 uint16_t counterUidA = counters.begin()->first; // First valid counter UID
2848 uint16_t counterUidB = (counters.begin()++)->first; // Second valid counter UID
Matteo Martincighe8485382019-10-10 14:08:21 +01002849
2850 uint32_t length = 8;
2851
2852 auto data = std::make_unique<unsigned char[]>(length);
2853 WriteUint32(data.get(), 0, capturePeriod);
2854 WriteUint16(data.get(), 4, counterUidA);
2855 WriteUint16(data.get(), 6, counterUidB);
2856
2857 // Create the Periodic Counter Selection packet
Keith Davis3201eea2019-10-24 17:30:41 +01002858 Packet periodicCounterSelectionPacket(header, length, data); // Length > 0, this will start the Period Counter
2859 // Capture thread
Matteo Martincighe8485382019-10-10 14:08:21 +01002860
2861 // Write the packet to the mock profiling connection
2862 mockProfilingConnection->WritePacket(std::move(periodicCounterSelectionPacket));
2863
Finn Williams09ad6f92019-12-19 17:05:18 +00002864 // Expecting one PeriodicCounterSelection Packet with a length of 16
2865 // And at least one PeriodicCounterCapture Packet with a length of 28
2866 BOOST_CHECK(helper.WaitForPacketsSent(mockProfilingConnection, PacketType::PeriodicCounterSelection, 16) == 1);
2867 BOOST_CHECK(helper.WaitForPacketsSent(mockProfilingConnection, PacketType::PeriodicCounterCapture, 28) >= 1);
Matteo Martincighe8485382019-10-10 14:08:21 +01002868
2869 // The Periodic Counter Selection Handler should not have updated the profiling state
2870 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Active);
Matteo Martincigh8efc5002019-10-10 14:30:29 +01002871
2872 // Reset the profiling service to stop any running thread
2873 options.m_EnableProfiling = false;
2874 profilingService.ResetExternalProfilingOptions(options, true);
2875}
2876
Jim Flynn53e46992019-10-14 12:31:10 +01002877BOOST_AUTO_TEST_CASE(CheckProfilingServiceDisconnect)
2878{
Jim Flynn53e46992019-10-14 12:31:10 +01002879 // Reset the profiling service to the uninitialized state
2880 armnn::Runtime::CreationOptions::ExternalProfilingOptions options;
Keith Davis3201eea2019-10-24 17:30:41 +01002881 options.m_EnableProfiling = true;
Sadik Armagan3184c902020-03-18 10:57:30 +00002882 armnn::profiling::ProfilingService profilingService;
Jim Flynn53e46992019-10-14 12:31:10 +01002883 profilingService.ResetExternalProfilingOptions(options, true);
2884
Sadik Armagan3184c902020-03-18 10:57:30 +00002885 // Swap the profiling connection factory in the profiling service instance with our mock one
2886 SwapProfilingConnectionFactoryHelper helper(profilingService);
2887
Jim Flynn53e46992019-10-14 12:31:10 +01002888 // Try to disconnect the profiling service while in the "Uninitialised" state
2889 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Uninitialised);
2890 profilingService.Disconnect();
Keith Davis3201eea2019-10-24 17:30:41 +01002891 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Uninitialised); // The state should not change
Jim Flynn53e46992019-10-14 12:31:10 +01002892
2893 // Try to disconnect the profiling service while in the "NotConnected" state
Keith Davis3201eea2019-10-24 17:30:41 +01002894 profilingService.Update(); // Initialize the counter directory
Jim Flynn53e46992019-10-14 12:31:10 +01002895 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::NotConnected);
2896 profilingService.Disconnect();
Keith Davis3201eea2019-10-24 17:30:41 +01002897 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::NotConnected); // The state should not change
Jim Flynn53e46992019-10-14 12:31:10 +01002898
2899 // Try to disconnect the profiling service while in the "WaitingForAck" state
Keith Davis3201eea2019-10-24 17:30:41 +01002900 profilingService.Update(); // Create the profiling connection
Jim Flynn53e46992019-10-14 12:31:10 +01002901 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::WaitingForAck);
2902 profilingService.Disconnect();
Keith Davis3201eea2019-10-24 17:30:41 +01002903 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::WaitingForAck); // The state should not change
Jim Flynn53e46992019-10-14 12:31:10 +01002904
2905 // Try to disconnect the profiling service while in the "Active" state
Keith Davis3201eea2019-10-24 17:30:41 +01002906 profilingService.Update(); // Start the command handler and the send thread
Jim Flynn53e46992019-10-14 12:31:10 +01002907
Colm Donelan2ba48d22019-11-29 09:10:59 +00002908 // Get the mock profiling connection
2909 MockProfilingConnection* mockProfilingConnection = helper.GetMockProfilingConnection();
2910 BOOST_CHECK(mockProfilingConnection);
2911
Jim Flynn53e46992019-10-14 12:31:10 +01002912 // Wait for the Stream Metadata packet the be sent
2913 // (we are not testing the connection acknowledgement here so it will be ignored by this test)
Finn Williams09ad6f92019-12-19 17:05:18 +00002914 helper.WaitForPacketsSent(mockProfilingConnection, PacketType::StreamMetaData);
Jim Flynn53e46992019-10-14 12:31:10 +01002915
2916 // Force the profiling service to the "Active" state
2917 helper.ForceTransitionToState(ProfilingState::Active);
2918 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Active);
2919
Jim Flynn53e46992019-10-14 12:31:10 +01002920 // Check that the profiling connection is open
2921 BOOST_CHECK(mockProfilingConnection->IsOpen());
2922
2923 profilingService.Disconnect();
Colm Donelan2ba48d22019-11-29 09:10:59 +00002924 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::NotConnected); // The state should have changed
Jim Flynn53e46992019-10-14 12:31:10 +01002925
2926 // Check that the profiling connection has been reset
2927 mockProfilingConnection = helper.GetMockProfilingConnection();
2928 BOOST_CHECK(mockProfilingConnection == nullptr);
2929
2930 // Reset the profiling service to stop any running thread
2931 options.m_EnableProfiling = false;
2932 profilingService.ResetExternalProfilingOptions(options, true);
2933}
2934
Matteo Martincigh994b5342019-10-11 17:19:56 +01002935BOOST_AUTO_TEST_CASE(CheckProfilingServiceGoodPerJobCounterSelectionPacket)
2936{
Matteo Martincigh994b5342019-10-11 17:19:56 +01002937 // Reset the profiling service to the uninitialized state
2938 armnn::Runtime::CreationOptions::ExternalProfilingOptions options;
Keith Davis3201eea2019-10-24 17:30:41 +01002939 options.m_EnableProfiling = true;
Sadik Armagan3184c902020-03-18 10:57:30 +00002940 armnn::profiling::ProfilingService profilingService;
Matteo Martincigh994b5342019-10-11 17:19:56 +01002941 profilingService.ResetExternalProfilingOptions(options, true);
2942
Sadik Armagan3184c902020-03-18 10:57:30 +00002943 // Swap the profiling connection factory in the profiling service instance with our mock one
2944 SwapProfilingConnectionFactoryHelper helper(profilingService);
2945
Matteo Martincigh994b5342019-10-11 17:19:56 +01002946 // Bring the profiling service to the "Active" state
2947 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Uninitialised);
Keith Davis3201eea2019-10-24 17:30:41 +01002948 profilingService.Update(); // Initialize the counter directory
Matteo Martincigh994b5342019-10-11 17:19:56 +01002949 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::NotConnected);
Keith Davis3201eea2019-10-24 17:30:41 +01002950 profilingService.Update(); // Create the profiling connection
Matteo Martincigh994b5342019-10-11 17:19:56 +01002951 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::WaitingForAck);
Keith Davis3201eea2019-10-24 17:30:41 +01002952 profilingService.Update(); // Start the command handler and the send thread
Matteo Martincigh994b5342019-10-11 17:19:56 +01002953
Colm Donelan2ba48d22019-11-29 09:10:59 +00002954 // Get the mock profiling connection
2955 MockProfilingConnection* mockProfilingConnection = helper.GetMockProfilingConnection();
2956 BOOST_CHECK(mockProfilingConnection);
2957
Matteo Martincigh994b5342019-10-11 17:19:56 +01002958 // Wait for the Stream Metadata packet the be sent
2959 // (we are not testing the connection acknowledgement here so it will be ignored by this test)
Finn Williams09ad6f92019-12-19 17:05:18 +00002960 helper.WaitForPacketsSent(mockProfilingConnection, PacketType::StreamMetaData);
Matteo Martincigh994b5342019-10-11 17:19:56 +01002961
2962 // Force the profiling service to the "Active" state
2963 helper.ForceTransitionToState(ProfilingState::Active);
2964 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Active);
2965
Matteo Martincigh994b5342019-10-11 17:19:56 +01002966 // Write a "Per-Job Counter Selection" packet into the mock profiling connection, to simulate an input from an
2967 // external profiling service
2968
2969 // Per-Job Counter Selection packet header:
2970 // 26:31 [6] packet_family: Control Packet Family, value 0b000000
2971 // 16:25 [10] packet_id: Packet identifier, value 0b0000000100
2972 // 8:15 [8] reserved: Reserved, value 0b00000000
2973 // 0:7 [8] reserved: Reserved, value 0b00000000
2974 uint32_t packetFamily = 0;
2975 uint32_t packetId = 5;
Keith Davis3201eea2019-10-24 17:30:41 +01002976 uint32_t header = ((packetFamily & 0x0000003F) << 26) | ((packetId & 0x000003FF) << 16);
Matteo Martincigh994b5342019-10-11 17:19:56 +01002977
2978 // Create the Per-Job Counter Selection packet
Keith Davis3201eea2019-10-24 17:30:41 +01002979 Packet periodicCounterSelectionPacket(header); // Length == 0, this will disable the collection of counters
Matteo Martincigh994b5342019-10-11 17:19:56 +01002980
2981 // Write the packet to the mock profiling connection
2982 mockProfilingConnection->WritePacket(std::move(periodicCounterSelectionPacket));
2983
2984 // Wait for a bit (must at least be the delay value of the mock profiling connection) to make sure that
2985 // the Per-Job Counter Selection packet gets processed by the profiling service
Colm Donelan2ba48d22019-11-29 09:10:59 +00002986 std::this_thread::sleep_for(std::chrono::milliseconds(5));
Matteo Martincigh994b5342019-10-11 17:19:56 +01002987
Matteo Martincigh994b5342019-10-11 17:19:56 +01002988 // The Per-Job Counter Selection Command Handler should not have updated the profiling state
2989 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Active);
2990
Finn Williams09ad6f92019-12-19 17:05:18 +00002991 // The Per-Job Counter Selection packets are dropped silently, so there should be no reply coming
2992 // from the profiling service
2993 const auto StreamMetaDataSize = static_cast<unsigned long>(
2994 helper.WaitForPacketsSent(mockProfilingConnection, PacketType::StreamMetaData, 0, 0));
2995 BOOST_CHECK(StreamMetaDataSize == mockProfilingConnection->GetWrittenDataSize());
2996
Matteo Martincigh994b5342019-10-11 17:19:56 +01002997 // Reset the profiling service to stop any running thread
2998 options.m_EnableProfiling = false;
2999 profilingService.ResetExternalProfilingOptions(options, true);
3000}
3001
Jim Flynn672d06e2019-10-15 10:18:11 +01003002BOOST_AUTO_TEST_CASE(CheckConfigureProfilingServiceOn)
3003{
3004 armnn::Runtime::CreationOptions::ExternalProfilingOptions options;
Keith Davis3201eea2019-10-24 17:30:41 +01003005 options.m_EnableProfiling = true;
Sadik Armagan3184c902020-03-18 10:57:30 +00003006 armnn::profiling::ProfilingService profilingService;
Jim Flynn672d06e2019-10-15 10:18:11 +01003007 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Uninitialised);
3008 profilingService.ConfigureProfilingService(options);
3009 // should get as far as NOT_CONNECTED
3010 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::NotConnected);
3011 // Reset the profiling service to stop any running thread
3012 options.m_EnableProfiling = false;
3013 profilingService.ResetExternalProfilingOptions(options, true);
3014}
3015
3016BOOST_AUTO_TEST_CASE(CheckConfigureProfilingServiceOff)
3017{
3018 armnn::Runtime::CreationOptions::ExternalProfilingOptions options;
Sadik Armagan3184c902020-03-18 10:57:30 +00003019 armnn::profiling::ProfilingService profilingService;
Jim Flynn672d06e2019-10-15 10:18:11 +01003020 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Uninitialised);
3021 profilingService.ConfigureProfilingService(options);
3022 // should not move from Uninitialised
3023 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Uninitialised);
3024 // Reset the profiling service to stop any running thread
3025 options.m_EnableProfiling = false;
3026 profilingService.ResetExternalProfilingOptions(options, true);
3027}
3028
Colm Donelan2ba48d22019-11-29 09:10:59 +00003029BOOST_AUTO_TEST_CASE(CheckProfilingServiceEnabled)
3030{
3031 // Locally reduce log level to "Warning", as this test needs to parse a warning message from the standard output
3032 LogLevelSwapper logLevelSwapper(armnn::LogSeverity::Warning);
3033 armnn::Runtime::CreationOptions::ExternalProfilingOptions options;
3034 options.m_EnableProfiling = true;
Sadik Armagan3184c902020-03-18 10:57:30 +00003035 armnn::profiling::ProfilingService profilingService;
Colm Donelan2ba48d22019-11-29 09:10:59 +00003036 profilingService.ResetExternalProfilingOptions(options, true);
3037 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Uninitialised);
3038 profilingService.Update();
3039 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::NotConnected);
3040
3041 // Redirect the output to a local stream so that we can parse the warning message
3042 std::stringstream ss;
3043 StreamRedirector streamRedirector(std::cout, ss.rdbuf());
3044 profilingService.Update();
Finn Williams09ad6f92019-12-19 17:05:18 +00003045
3046 // Reset the profiling service to stop any running thread
3047 options.m_EnableProfiling = false;
3048 profilingService.ResetExternalProfilingOptions(options, true);
3049
Colm Donelan2ba48d22019-11-29 09:10:59 +00003050 streamRedirector.CancelRedirect();
3051
3052 // Check that the expected error has occurred and logged to the standard output
David Monahana8837bf2020-04-16 10:01:56 +01003053 if (ss.str().find("Cannot connect to stream socket: Connection refused") == std::string::npos)
Colm Donelan2ba48d22019-11-29 09:10:59 +00003054 {
3055 std::cout << ss.str();
3056 BOOST_FAIL("Expected string not found.");
3057 }
Colm Donelan2ba48d22019-11-29 09:10:59 +00003058}
3059
3060BOOST_AUTO_TEST_CASE(CheckProfilingServiceEnabledRuntime)
3061{
3062 // Locally reduce log level to "Warning", as this test needs to parse a warning message from the standard output
3063 LogLevelSwapper logLevelSwapper(armnn::LogSeverity::Warning);
3064 armnn::Runtime::CreationOptions::ExternalProfilingOptions options;
Sadik Armagan3184c902020-03-18 10:57:30 +00003065 armnn::profiling::ProfilingService profilingService;
Colm Donelan2ba48d22019-11-29 09:10:59 +00003066 profilingService.ResetExternalProfilingOptions(options, true);
3067 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Uninitialised);
3068 profilingService.Update();
3069 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Uninitialised);
3070 options.m_EnableProfiling = true;
3071 profilingService.ResetExternalProfilingOptions(options);
3072 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Uninitialised);
3073 profilingService.Update();
3074 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::NotConnected);
3075
3076 // Redirect the output to a local stream so that we can parse the warning message
3077 std::stringstream ss;
3078 StreamRedirector streamRedirector(std::cout, ss.rdbuf());
3079 profilingService.Update();
3080
Finn Williams09ad6f92019-12-19 17:05:18 +00003081 // Reset the profiling service to stop any running thread
3082 options.m_EnableProfiling = false;
3083 profilingService.ResetExternalProfilingOptions(options, true);
3084
Colm Donelan2ba48d22019-11-29 09:10:59 +00003085 streamRedirector.CancelRedirect();
3086
3087 // Check that the expected error has occurred and logged to the standard output
David Monahana8837bf2020-04-16 10:01:56 +01003088 if (ss.str().find("Cannot connect to stream socket: Connection refused") == std::string::npos)
Colm Donelan2ba48d22019-11-29 09:10:59 +00003089 {
3090 std::cout << ss.str();
3091 BOOST_FAIL("Expected string not found.");
3092 }
Colm Donelan2ba48d22019-11-29 09:10:59 +00003093}
3094
3095BOOST_AUTO_TEST_CASE(CheckProfilingServiceBadConnectionAcknowledgedPacket)
3096{
3097 // Locally reduce log level to "Warning", as this test needs to parse a warning message from the standard output
3098 LogLevelSwapper logLevelSwapper(armnn::LogSeverity::Warning);
Sadik Armagan3184c902020-03-18 10:57:30 +00003099
Colm Donelan2ba48d22019-11-29 09:10:59 +00003100
3101 // Redirect the standard output to a local stream so that we can parse the warning message
3102 std::stringstream ss;
3103 StreamRedirector streamRedirector(std::cout, ss.rdbuf());
3104
Colm Donelan2ba48d22019-11-29 09:10:59 +00003105 // Reset the profiling service to the uninitialized state
3106 armnn::Runtime::CreationOptions::ExternalProfilingOptions options;
3107 options.m_EnableProfiling = true;
Sadik Armagan3184c902020-03-18 10:57:30 +00003108 armnn::profiling::ProfilingService profilingService;
Colm Donelan2ba48d22019-11-29 09:10:59 +00003109 profilingService.ResetExternalProfilingOptions(options, true);
3110
Sadik Armagan3184c902020-03-18 10:57:30 +00003111 // Swap the profiling connection factory in the profiling service instance with our mock one
3112 SwapProfilingConnectionFactoryHelper helper(profilingService);
3113
Colm Donelan2ba48d22019-11-29 09:10:59 +00003114 // Bring the profiling service to the "WaitingForAck" state
3115 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Uninitialised);
3116 profilingService.Update(); // Initialize the counter directory
3117 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::NotConnected);
3118 profilingService.Update(); // Create the profiling connection
3119
3120 // Get the mock profiling connection
3121 MockProfilingConnection* mockProfilingConnection = helper.GetMockProfilingConnection();
3122 BOOST_CHECK(mockProfilingConnection);
3123
Colm Donelan2ba48d22019-11-29 09:10:59 +00003124 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::WaitingForAck);
Colm Donelan2ba48d22019-11-29 09:10:59 +00003125
3126 // Connection Acknowledged Packet header (word 0, word 1 is always zero):
3127 // 26:31 [6] packet_family: Control Packet Family, value 0b000000
3128 // 16:25 [10] packet_id: Packet identifier, value 0b0000000001
3129 // 8:15 [8] reserved: Reserved, value 0b00000000
3130 // 0:7 [8] reserved: Reserved, value 0b00000000
3131 uint32_t packetFamily = 0;
3132 uint32_t packetId = 37; // Wrong packet id!!!
3133 uint32_t header = ((packetFamily & 0x0000003F) << 26) | ((packetId & 0x000003FF) << 16);
3134
3135 // Create the Connection Acknowledged Packet
3136 Packet connectionAcknowledgedPacket(header);
Finn Williams09ad6f92019-12-19 17:05:18 +00003137 // Write an invalid "Connection Acknowledged" packet into the mock profiling connection, to simulate an invalid
3138 // reply from an external profiling service
Colm Donelan2ba48d22019-11-29 09:10:59 +00003139 mockProfilingConnection->WritePacket(std::move(connectionAcknowledgedPacket));
3140
Finn Williams09ad6f92019-12-19 17:05:18 +00003141 // Start the command thread
3142 profilingService.Update();
3143
3144 // Wait for the command thread to join
3145 options.m_EnableProfiling = false;
3146 profilingService.ResetExternalProfilingOptions(options, true);
Colm Donelan2ba48d22019-11-29 09:10:59 +00003147
3148 streamRedirector.CancelRedirect();
3149
3150 // Check that the expected error has occurred and logged to the standard output
David Monahana8837bf2020-04-16 10:01:56 +01003151 if (ss.str().find("Functor with requested PacketId=37 and Version=4194304 does not exist") == std::string::npos)
Colm Donelan2ba48d22019-11-29 09:10:59 +00003152 {
3153 std::cout << ss.str();
3154 BOOST_FAIL("Expected string not found.");
3155 }
Colm Donelan2ba48d22019-11-29 09:10:59 +00003156}
3157
3158BOOST_AUTO_TEST_CASE(CheckProfilingServiceBadRequestCounterDirectoryPacket)
3159{
3160 // Locally reduce log level to "Warning", as this test needs to parse a warning message from the standard output
3161 LogLevelSwapper logLevelSwapper(armnn::LogSeverity::Warning);
Colm Donelan2ba48d22019-11-29 09:10:59 +00003162
3163 // Redirect the standard output to a local stream so that we can parse the warning message
3164 std::stringstream ss;
3165 StreamRedirector streamRedirector(std::cout, ss.rdbuf());
3166
3167 // Reset the profiling service to the uninitialized state
3168 armnn::Runtime::CreationOptions::ExternalProfilingOptions options;
3169 options.m_EnableProfiling = true;
Sadik Armagan3184c902020-03-18 10:57:30 +00003170 armnn::profiling::ProfilingService profilingService;
Colm Donelan2ba48d22019-11-29 09:10:59 +00003171 profilingService.ResetExternalProfilingOptions(options, true);
3172
Sadik Armagan3184c902020-03-18 10:57:30 +00003173 // Swap the profiling connection factory in the profiling service instance with our mock one
3174 SwapProfilingConnectionFactoryHelper helper(profilingService);
3175
Colm Donelan2ba48d22019-11-29 09:10:59 +00003176 // Bring the profiling service to the "Active" state
3177 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Uninitialised);
3178 helper.ForceTransitionToState(ProfilingState::NotConnected);
3179 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::NotConnected);
3180 profilingService.Update(); // Create the profiling connection
3181 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::WaitingForAck);
Colm Donelan2ba48d22019-11-29 09:10:59 +00003182
3183 // Get the mock profiling connection
3184 MockProfilingConnection* mockProfilingConnection = helper.GetMockProfilingConnection();
3185 BOOST_CHECK(mockProfilingConnection);
3186
Colm Donelan2ba48d22019-11-29 09:10:59 +00003187 // Write a valid "Request Counter Directory" packet into the mock profiling connection, to simulate a valid
3188 // reply from an external profiling service
3189
3190 // Request Counter Directory packet header (word 0, word 1 is always zero):
3191 // 26:31 [6] packet_family: Control Packet Family, value 0b000000
3192 // 16:25 [10] packet_id: Packet identifier, value 0b0000000011
3193 // 8:15 [8] reserved: Reserved, value 0b00000000
3194 // 0:7 [8] reserved: Reserved, value 0b00000000
3195 uint32_t packetFamily = 0;
3196 uint32_t packetId = 123; // Wrong packet id!!!
3197 uint32_t header = ((packetFamily & 0x0000003F) << 26) | ((packetId & 0x000003FF) << 16);
3198
3199 // Create the Request Counter Directory packet
3200 Packet requestCounterDirectoryPacket(header);
3201
3202 // Write the packet to the mock profiling connection
3203 mockProfilingConnection->WritePacket(std::move(requestCounterDirectoryPacket));
3204
Finn Williams09ad6f92019-12-19 17:05:18 +00003205 // Start the command handler and the send thread
3206 profilingService.Update();
3207
3208 // Reset the profiling service to stop and join any running thread
3209 options.m_EnableProfiling = false;
3210 profilingService.ResetExternalProfilingOptions(options, true);
Colm Donelan2ba48d22019-11-29 09:10:59 +00003211
3212 streamRedirector.CancelRedirect();
3213
3214 // Check that the expected error has occurred and logged to the standard output
David Monahana8837bf2020-04-16 10:01:56 +01003215 if (ss.str().find("Functor with requested PacketId=123 and Version=4194304 does not exist") == std::string::npos)
Colm Donelan2ba48d22019-11-29 09:10:59 +00003216 {
3217 std::cout << ss.str();
3218 BOOST_FAIL("Expected string not found.");
3219 }
Colm Donelan2ba48d22019-11-29 09:10:59 +00003220}
3221
3222BOOST_AUTO_TEST_CASE(CheckProfilingServiceBadPeriodicCounterSelectionPacket)
3223{
3224 // Locally reduce log level to "Warning", as this test needs to parse a warning message from the standard output
3225 LogLevelSwapper logLevelSwapper(armnn::LogSeverity::Warning);
Colm Donelan2ba48d22019-11-29 09:10:59 +00003226
3227 // Redirect the standard output to a local stream so that we can parse the warning message
3228 std::stringstream ss;
3229 StreamRedirector streamRedirector(std::cout, ss.rdbuf());
3230
3231 // Reset the profiling service to the uninitialized state
3232 armnn::Runtime::CreationOptions::ExternalProfilingOptions options;
3233 options.m_EnableProfiling = true;
Sadik Armagan3184c902020-03-18 10:57:30 +00003234 armnn::profiling::ProfilingService profilingService;
Colm Donelan2ba48d22019-11-29 09:10:59 +00003235 profilingService.ResetExternalProfilingOptions(options, true);
3236
Sadik Armagan3184c902020-03-18 10:57:30 +00003237 // Swap the profiling connection factory in the profiling service instance with our mock one
3238 SwapProfilingConnectionFactoryHelper helper(profilingService);
3239
Colm Donelan2ba48d22019-11-29 09:10:59 +00003240 // Bring the profiling service to the "Active" state
3241 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::Uninitialised);
3242 profilingService.Update(); // Initialize the counter directory
3243 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::NotConnected);
3244 profilingService.Update(); // Create the profiling connection
3245 BOOST_CHECK(profilingService.GetCurrentState() == ProfilingState::WaitingForAck);
3246 profilingService.Update(); // Start the command handler and the send thread
3247
3248 // Get the mock profiling connection
3249 MockProfilingConnection* mockProfilingConnection = helper.GetMockProfilingConnection();
3250 BOOST_CHECK(mockProfilingConnection);
3251
Colm Donelan2ba48d22019-11-29 09:10:59 +00003252 // Write a "Periodic Counter Selection" packet into the mock profiling connection, to simulate an input from an
3253 // external profiling service
3254
3255 // Periodic Counter Selection packet header:
3256 // 26:31 [6] packet_family: Control Packet Family, value 0b000000
3257 // 16:25 [10] packet_id: Packet identifier, value 0b0000000100
3258 // 8:15 [8] reserved: Reserved, value 0b00000000
3259 // 0:7 [8] reserved: Reserved, value 0b00000000
3260 uint32_t packetFamily = 0;
3261 uint32_t packetId = 999; // Wrong packet id!!!
3262 uint32_t header = ((packetFamily & 0x0000003F) << 26) | ((packetId & 0x000003FF) << 16);
3263
3264 // Create the Periodic Counter Selection packet
3265 Packet periodicCounterSelectionPacket(header); // Length == 0, this will disable the collection of counters
3266
3267 // Write the packet to the mock profiling connection
3268 mockProfilingConnection->WritePacket(std::move(periodicCounterSelectionPacket));
Finn Williams09ad6f92019-12-19 17:05:18 +00003269 profilingService.Update();
Colm Donelan2ba48d22019-11-29 09:10:59 +00003270
Finn Williams09ad6f92019-12-19 17:05:18 +00003271 // Reset the profiling service to stop any running thread
3272 options.m_EnableProfiling = false;
3273 profilingService.ResetExternalProfilingOptions(options, true);
Colm Donelan2ba48d22019-11-29 09:10:59 +00003274
3275 // Check that the expected error has occurred and logged to the standard output
3276 streamRedirector.CancelRedirect();
3277
3278 // Check that the expected error has occurred and logged to the standard output
David Monahana8837bf2020-04-16 10:01:56 +01003279 if (ss.str().find("Functor with requested PacketId=999 and Version=4194304 does not exist") == std::string::npos)
Colm Donelan2ba48d22019-11-29 09:10:59 +00003280 {
3281 std::cout << ss.str();
3282 BOOST_FAIL("Expected string not found.");
3283 }
Colm Donelan2ba48d22019-11-29 09:10:59 +00003284}
Jim Flynn97897022020-02-02 12:52:59 +00003285
David Monahande803072020-01-30 12:44:23 +00003286BOOST_AUTO_TEST_CASE(CheckCounterIdMap)
3287{
3288 CounterIdMap counterIdMap;
3289 BOOST_CHECK_THROW(counterIdMap.GetBackendId(0), armnn::Exception);
3290 BOOST_CHECK_THROW(counterIdMap.GetGlobalId(0, armnn::profiling::BACKEND_ID), armnn::Exception);
3291
3292 uint16_t globalCounterIds = 0;
3293
3294 armnn::BackendId cpuRefId(armnn::Compute::CpuRef);
3295 armnn::BackendId cpuAccId(armnn::Compute::CpuAcc);
3296
3297 std::vector<uint16_t> cpuRefCounters = {0, 1, 2, 3};
3298 std::vector<uint16_t> cpuAccCounters = {0, 1};
3299
3300 for (uint16_t backendCounterId : cpuRefCounters)
3301 {
3302 counterIdMap.RegisterMapping(globalCounterIds, backendCounterId, cpuRefId);
3303 ++globalCounterIds;
3304 }
3305 for (uint16_t backendCounterId : cpuAccCounters)
3306 {
3307 counterIdMap.RegisterMapping(globalCounterIds, backendCounterId, cpuAccId);
3308 ++globalCounterIds;
3309 }
3310
3311 BOOST_CHECK(counterIdMap.GetBackendId(0) == (std::pair<uint16_t, armnn::BackendId>(0, cpuRefId)));
3312 BOOST_CHECK(counterIdMap.GetBackendId(1) == (std::pair<uint16_t, armnn::BackendId>(1, cpuRefId)));
3313 BOOST_CHECK(counterIdMap.GetBackendId(2) == (std::pair<uint16_t, armnn::BackendId>(2, cpuRefId)));
3314 BOOST_CHECK(counterIdMap.GetBackendId(3) == (std::pair<uint16_t, armnn::BackendId>(3, cpuRefId)));
3315 BOOST_CHECK(counterIdMap.GetBackendId(4) == (std::pair<uint16_t, armnn::BackendId>(0, cpuAccId)));
3316 BOOST_CHECK(counterIdMap.GetBackendId(5) == (std::pair<uint16_t, armnn::BackendId>(1, cpuAccId)));
3317
3318 BOOST_CHECK(counterIdMap.GetGlobalId(0, cpuRefId) == 0);
3319 BOOST_CHECK(counterIdMap.GetGlobalId(1, cpuRefId) == 1);
3320 BOOST_CHECK(counterIdMap.GetGlobalId(2, cpuRefId) == 2);
3321 BOOST_CHECK(counterIdMap.GetGlobalId(3, cpuRefId) == 3);
3322 BOOST_CHECK(counterIdMap.GetGlobalId(0, cpuAccId) == 4);
3323 BOOST_CHECK(counterIdMap.GetGlobalId(1, cpuAccId) == 5);
3324}
Colm Donelan2ba48d22019-11-29 09:10:59 +00003325
Jim Flynn97897022020-02-02 12:52:59 +00003326BOOST_AUTO_TEST_CASE(CheckRegisterBackendCounters)
3327{
3328 uint16_t globalCounterIds = armnn::profiling::INFERENCES_RUN;
3329 armnn::BackendId cpuRefId(armnn::Compute::CpuRef);
3330
Jim Flynn97897022020-02-02 12:52:59 +00003331 // Reset the profiling service to the uninitialized state
3332 armnn::Runtime::CreationOptions::ExternalProfilingOptions options;
3333 options.m_EnableProfiling = true;
Sadik Armagan3184c902020-03-18 10:57:30 +00003334 ProfilingService profilingService;
Jim Flynn97897022020-02-02 12:52:59 +00003335 profilingService.ResetExternalProfilingOptions(options, true);
3336
Sadik Armagan3184c902020-03-18 10:57:30 +00003337 RegisterBackendCounters registerBackendCounters(globalCounterIds, cpuRefId, profilingService);
3338
3339
3340
Jim Flynn97897022020-02-02 12:52:59 +00003341 BOOST_CHECK(profilingService.GetCounterDirectory().GetCategories().empty());
3342 registerBackendCounters.RegisterCategory("categoryOne");
3343 auto categoryOnePtr = profilingService.GetCounterDirectory().GetCategory("categoryOne");
3344 BOOST_CHECK(categoryOnePtr);
3345
3346 BOOST_CHECK(profilingService.GetCounterDirectory().GetDevices().empty());
3347 globalCounterIds = registerBackendCounters.RegisterDevice("deviceOne");
3348 auto deviceOnePtr = profilingService.GetCounterDirectory().GetDevice(globalCounterIds);
3349 BOOST_CHECK(deviceOnePtr);
3350 BOOST_CHECK(deviceOnePtr->m_Name == "deviceOne");
3351
3352 BOOST_CHECK(profilingService.GetCounterDirectory().GetCounterSets().empty());
3353 globalCounterIds = registerBackendCounters.RegisterCounterSet("counterSetOne");
3354 auto counterSetOnePtr = profilingService.GetCounterDirectory().GetCounterSet(globalCounterIds);
3355 BOOST_CHECK(counterSetOnePtr);
3356 BOOST_CHECK(counterSetOnePtr->m_Name == "counterSetOne");
3357
3358 uint16_t newGlobalCounterId = registerBackendCounters.RegisterCounter(0,
3359 "categoryOne",
3360 0,
3361 0,
3362 1.f,
3363 "CounterOne",
3364 "first test counter");
3365 BOOST_CHECK(newGlobalCounterId = armnn::profiling::INFERENCES_RUN + 1);
3366 uint16_t mappedGlobalId = profilingService.GetCounterMappings().GetGlobalId(0, cpuRefId);
3367 BOOST_CHECK(mappedGlobalId == newGlobalCounterId);
3368 auto backendMapping = profilingService.GetCounterMappings().GetBackendId(newGlobalCounterId);
3369 BOOST_CHECK(backendMapping.first == 0);
3370 BOOST_CHECK(backendMapping.second == cpuRefId);
3371
3372 // Reset the profiling service to stop any running thread
3373 options.m_EnableProfiling = false;
3374 profilingService.ResetExternalProfilingOptions(options, true);
3375}
3376
James Conroy2dcd3fe2020-02-06 18:34:52 +00003377BOOST_AUTO_TEST_CASE(CheckCounterStatusQuery)
3378{
3379 armnn::IRuntime::CreationOptions options;
3380 options.m_ProfilingOptions.m_EnableProfiling = true;
3381
3382 // Reset the profiling service to the uninitialized state
Sadik Armagan3184c902020-03-18 10:57:30 +00003383 ProfilingService profilingService;
James Conroy2dcd3fe2020-02-06 18:34:52 +00003384 profilingService.ResetExternalProfilingOptions(options.m_ProfilingOptions, true);
3385
3386 const armnn::BackendId cpuRefId(armnn::Compute::CpuRef);
3387 const armnn::BackendId cpuAccId(armnn::Compute::CpuAcc);
3388
3389 // Create BackendProfiling for each backend
3390 BackendProfiling backendProfilingCpuRef(options, profilingService, cpuRefId);
3391 BackendProfiling backendProfilingCpuAcc(options, profilingService, cpuAccId);
3392
3393 uint16_t initialNumGlobalCounterIds = armnn::profiling::INFERENCES_RUN;
3394
3395 // Create RegisterBackendCounters for CpuRef
Sadik Armagan3184c902020-03-18 10:57:30 +00003396 RegisterBackendCounters registerBackendCountersCpuRef(initialNumGlobalCounterIds, cpuRefId, profilingService);
James Conroy2dcd3fe2020-02-06 18:34:52 +00003397
3398 // Create 'testCategory' in CounterDirectory (backend agnostic)
3399 BOOST_CHECK(profilingService.GetCounterDirectory().GetCategories().empty());
3400 registerBackendCountersCpuRef.RegisterCategory("testCategory");
3401 auto categoryOnePtr = profilingService.GetCounterDirectory().GetCategory("testCategory");
3402 BOOST_CHECK(categoryOnePtr);
3403
3404 // Counters:
3405 // Global | Local | Backend
3406 // 5 | 0 | CpuRef
3407 // 6 | 1 | CpuRef
3408 // 7 | 1 | CpuAcc
3409
3410 std::vector<uint16_t> cpuRefCounters = {0, 1};
3411 std::vector<uint16_t> cpuAccCounters = {0};
3412
3413 // Register the backend counters for CpuRef and validate GetGlobalId and GetBackendId
3414 uint16_t currentNumGlobalCounterIds = registerBackendCountersCpuRef.RegisterCounter(
3415 0, "testCategory", 0, 0, 1.f, "CpuRefCounter0", "Zeroth CpuRef Counter");
3416 BOOST_CHECK(currentNumGlobalCounterIds == initialNumGlobalCounterIds + 1);
3417 uint16_t mappedGlobalId = profilingService.GetCounterMappings().GetGlobalId(0, cpuRefId);
3418 BOOST_CHECK(mappedGlobalId == currentNumGlobalCounterIds);
3419 auto backendMapping = profilingService.GetCounterMappings().GetBackendId(currentNumGlobalCounterIds);
3420 BOOST_CHECK(backendMapping.first == 0);
3421 BOOST_CHECK(backendMapping.second == cpuRefId);
3422
3423 currentNumGlobalCounterIds = registerBackendCountersCpuRef.RegisterCounter(
3424 1, "testCategory", 0, 0, 1.f, "CpuRefCounter1", "First CpuRef Counter");
3425 BOOST_CHECK(currentNumGlobalCounterIds == initialNumGlobalCounterIds + 2);
3426 mappedGlobalId = profilingService.GetCounterMappings().GetGlobalId(1, cpuRefId);
3427 BOOST_CHECK(mappedGlobalId == currentNumGlobalCounterIds);
3428 backendMapping = profilingService.GetCounterMappings().GetBackendId(currentNumGlobalCounterIds);
3429 BOOST_CHECK(backendMapping.first == 1);
3430 BOOST_CHECK(backendMapping.second == cpuRefId);
3431
3432 // Create RegisterBackendCounters for CpuAcc
Sadik Armagan3184c902020-03-18 10:57:30 +00003433 RegisterBackendCounters registerBackendCountersCpuAcc(currentNumGlobalCounterIds, cpuAccId, profilingService);
James Conroy2dcd3fe2020-02-06 18:34:52 +00003434
3435 // Register the backend counter for CpuAcc and validate GetGlobalId and GetBackendId
3436 currentNumGlobalCounterIds = registerBackendCountersCpuAcc.RegisterCounter(
3437 0, "testCategory", 0, 0, 1.f, "CpuAccCounter0", "Zeroth CpuAcc Counter");
3438 BOOST_CHECK(currentNumGlobalCounterIds == initialNumGlobalCounterIds + 3);
3439 mappedGlobalId = profilingService.GetCounterMappings().GetGlobalId(0, cpuAccId);
3440 BOOST_CHECK(mappedGlobalId == currentNumGlobalCounterIds);
3441 backendMapping = profilingService.GetCounterMappings().GetBackendId(currentNumGlobalCounterIds);
3442 BOOST_CHECK(backendMapping.first == 0);
3443 BOOST_CHECK(backendMapping.second == cpuAccId);
3444
3445 // Create vectors for active counters
3446 const std::vector<uint16_t> activeGlobalCounterIds = {5}; // CpuRef(0) activated
3447 const std::vector<uint16_t> newActiveGlobalCounterIds = {6, 7}; // CpuRef(0) and CpuAcc(1) activated
3448
3449 const uint32_t capturePeriod = 200;
3450 const uint32_t newCapturePeriod = 100;
3451
3452 // Set capture period and active counters in CaptureData
Finn Williams032bc742020-02-12 11:02:34 +00003453 profilingService.SetCaptureData(capturePeriod, activeGlobalCounterIds, {});
James Conroy2dcd3fe2020-02-06 18:34:52 +00003454
3455 // Get vector of active counters for CpuRef and CpuAcc backends
3456 std::vector<CounterStatus> cpuRefCounterStatus = backendProfilingCpuRef.GetActiveCounters();
3457 std::vector<CounterStatus> cpuAccCounterStatus = backendProfilingCpuAcc.GetActiveCounters();
3458 BOOST_CHECK_EQUAL(cpuRefCounterStatus.size(), 1);
3459 BOOST_CHECK_EQUAL(cpuAccCounterStatus.size(), 0);
3460
3461 // Check active CpuRef counter
3462 BOOST_CHECK_EQUAL(cpuRefCounterStatus[0].m_GlobalCounterId, activeGlobalCounterIds[0]);
3463 BOOST_CHECK_EQUAL(cpuRefCounterStatus[0].m_BackendCounterId, cpuRefCounters[0]);
3464 BOOST_CHECK_EQUAL(cpuRefCounterStatus[0].m_SamplingRateInMicroseconds, capturePeriod);
3465 BOOST_CHECK_EQUAL(cpuRefCounterStatus[0].m_Enabled, true);
3466
3467 // Check inactive CpuRef counter
3468 CounterStatus inactiveCpuRefCounter = backendProfilingCpuRef.GetCounterStatus(cpuRefCounters[1]);
3469 BOOST_CHECK_EQUAL(inactiveCpuRefCounter.m_GlobalCounterId, 6);
3470 BOOST_CHECK_EQUAL(inactiveCpuRefCounter.m_BackendCounterId, cpuRefCounters[1]);
3471 BOOST_CHECK_EQUAL(inactiveCpuRefCounter.m_SamplingRateInMicroseconds, 0);
3472 BOOST_CHECK_EQUAL(inactiveCpuRefCounter.m_Enabled, false);
3473
3474 // Check inactive CpuAcc counter
3475 CounterStatus inactiveCpuAccCounter = backendProfilingCpuAcc.GetCounterStatus(cpuAccCounters[0]);
3476 BOOST_CHECK_EQUAL(inactiveCpuAccCounter.m_GlobalCounterId, 7);
3477 BOOST_CHECK_EQUAL(inactiveCpuAccCounter.m_BackendCounterId, cpuAccCounters[0]);
3478 BOOST_CHECK_EQUAL(inactiveCpuAccCounter.m_SamplingRateInMicroseconds, 0);
3479 BOOST_CHECK_EQUAL(inactiveCpuAccCounter.m_Enabled, false);
3480
3481 // Set new capture period and new active counters in CaptureData
Finn Williams032bc742020-02-12 11:02:34 +00003482 profilingService.SetCaptureData(newCapturePeriod, newActiveGlobalCounterIds, {});
James Conroy2dcd3fe2020-02-06 18:34:52 +00003483
3484 // Get vector of active counters for CpuRef and CpuAcc backends
3485 cpuRefCounterStatus = backendProfilingCpuRef.GetActiveCounters();
3486 cpuAccCounterStatus = backendProfilingCpuAcc.GetActiveCounters();
3487 BOOST_CHECK_EQUAL(cpuRefCounterStatus.size(), 1);
3488 BOOST_CHECK_EQUAL(cpuAccCounterStatus.size(), 1);
3489
3490 // Check active CpuRef counter
3491 BOOST_CHECK_EQUAL(cpuRefCounterStatus[0].m_GlobalCounterId, newActiveGlobalCounterIds[0]);
3492 BOOST_CHECK_EQUAL(cpuRefCounterStatus[0].m_BackendCounterId, cpuRefCounters[1]);
3493 BOOST_CHECK_EQUAL(cpuRefCounterStatus[0].m_SamplingRateInMicroseconds, newCapturePeriod);
3494 BOOST_CHECK_EQUAL(cpuRefCounterStatus[0].m_Enabled, true);
3495
3496 // Check active CpuAcc counter
3497 BOOST_CHECK_EQUAL(cpuAccCounterStatus[0].m_GlobalCounterId, newActiveGlobalCounterIds[1]);
3498 BOOST_CHECK_EQUAL(cpuAccCounterStatus[0].m_BackendCounterId, cpuAccCounters[0]);
3499 BOOST_CHECK_EQUAL(cpuAccCounterStatus[0].m_SamplingRateInMicroseconds, newCapturePeriod);
3500 BOOST_CHECK_EQUAL(cpuAccCounterStatus[0].m_Enabled, true);
3501
3502 // Check inactive CpuRef counter
3503 inactiveCpuRefCounter = backendProfilingCpuRef.GetCounterStatus(cpuRefCounters[0]);
3504 BOOST_CHECK_EQUAL(inactiveCpuRefCounter.m_GlobalCounterId, 5);
3505 BOOST_CHECK_EQUAL(inactiveCpuRefCounter.m_BackendCounterId, cpuRefCounters[0]);
3506 BOOST_CHECK_EQUAL(inactiveCpuRefCounter.m_SamplingRateInMicroseconds, 0);
3507 BOOST_CHECK_EQUAL(inactiveCpuRefCounter.m_Enabled, false);
3508
3509 // Reset the profiling service to stop any running thread
3510 options.m_ProfilingOptions.m_EnableProfiling = false;
3511 profilingService.ResetExternalProfilingOptions(options.m_ProfilingOptions, true);
3512}
3513
Sadik Armagancab588a2020-02-17 11:33:31 +00003514BOOST_AUTO_TEST_CASE(CheckRegisterCounters)
3515{
3516 armnn::Runtime::CreationOptions options;
3517 options.m_ProfilingOptions.m_EnableProfiling = true;
3518 MockBufferManager mockBuffer(1024);
Sadik Armagan3184c902020-03-18 10:57:30 +00003519
Sadik Armagancab588a2020-02-17 11:33:31 +00003520 CaptureData captureData;
Keith Davis33ed2212020-03-30 10:43:41 +01003521 MockProfilingService mockProfilingService(mockBuffer, options.m_ProfilingOptions.m_EnableProfiling, captureData);
Sadik Armagancab588a2020-02-17 11:33:31 +00003522 armnn::BackendId cpuRefId(armnn::Compute::CpuRef);
3523
3524 mockProfilingService.RegisterMapping(6, 0, cpuRefId);
3525 mockProfilingService.RegisterMapping(7, 1, cpuRefId);
3526 mockProfilingService.RegisterMapping(8, 2, cpuRefId);
3527
3528 armnn::profiling::BackendProfiling backendProfiling(options,
3529 mockProfilingService,
3530 cpuRefId);
3531
3532 armnn::profiling::Timestamp timestamp;
3533 timestamp.timestamp = 1000998;
3534 timestamp.counterValues.emplace_back(0, 700);
3535 timestamp.counterValues.emplace_back(2, 93);
3536 std::vector<armnn::profiling::Timestamp> timestamps;
3537 timestamps.push_back(timestamp);
3538 backendProfiling.ReportCounters(timestamps);
3539
3540 auto readBuffer = mockBuffer.GetReadableBuffer();
3541
3542 uint32_t headerWord0 = ReadUint32(readBuffer, 0);
3543 uint32_t headerWord1 = ReadUint32(readBuffer, 4);
3544 uint64_t readTimestamp = ReadUint64(readBuffer, 8);
3545
3546 BOOST_TEST(((headerWord0 >> 26) & 0x0000003F) == 3); // packet family
3547 BOOST_TEST(((headerWord0 >> 19) & 0x0000007F) == 0); // packet class
3548 BOOST_TEST(((headerWord0 >> 16) & 0x00000007) == 0); // packet type
3549 BOOST_TEST(headerWord1 == 20); // data length
3550 BOOST_TEST(1000998 == readTimestamp); // capture period
3551
3552 uint32_t offset = 16;
3553 // Check Counter Index
3554 uint16_t readIndex = ReadUint16(readBuffer, offset);
3555 BOOST_TEST(6 == readIndex);
3556
3557 // Check Counter Value
3558 offset += 2;
3559 uint32_t readValue = ReadUint32(readBuffer, offset);
3560 BOOST_TEST(700 == readValue);
3561
3562 // Check Counter Index
3563 offset += 4;
3564 readIndex = ReadUint16(readBuffer, offset);
3565 BOOST_TEST(8 == readIndex);
3566
3567 // Check Counter Value
3568 offset += 2;
3569 readValue = ReadUint32(readBuffer, offset);
3570 BOOST_TEST(93 == readValue);
3571}
3572
Isabella Gottardia0687ee2020-03-11 18:04:20 +00003573BOOST_AUTO_TEST_CASE(CheckFileFormat) {
3574 // Locally reduce log level to "Warning", as this test needs to parse a warning message from the standard output
3575 LogLevelSwapper logLevelSwapper(armnn::LogSeverity::Warning);
3576
3577 // Create profiling options.
3578 armnn::Runtime::CreationOptions::ExternalProfilingOptions options;
3579 options.m_EnableProfiling = true;
3580 // Check the default value set to binary
3581 BOOST_CHECK(options.m_FileFormat == "binary");
3582
3583 // Change file format to an unsupported value
3584 options.m_FileFormat = "json";
3585 // Enable the profiling service
3586 armnn::profiling::ProfilingService profilingService;
3587 profilingService.ResetExternalProfilingOptions(options, true);
3588 // Start the command handler and the send thread
3589 profilingService.Update();
3590 BOOST_CHECK(profilingService.GetCurrentState()==ProfilingState::NotConnected);
3591
3592 // Redirect the output to a local stream so that we can parse the warning message
3593 std::stringstream ss;
3594 StreamRedirector streamRedirector(std::cout, ss.rdbuf());
3595
3596 // When Update is called and the current state is ProfilingState::NotConnected
3597 // an exception will be raised from GetProfilingConnection and displayed as warning in the output local stream
3598 profilingService.Update();
3599
3600 streamRedirector.CancelRedirect();
3601
3602 // Check that the expected error has occurred and logged to the standard output
David Monahana8837bf2020-04-16 10:01:56 +01003603 if (ss.str().find("Unsupported profiling file format, only binary is supported") == std::string::npos)
Isabella Gottardia0687ee2020-03-11 18:04:20 +00003604 {
3605 std::cout << ss.str();
3606 BOOST_FAIL("Expected string not found.");
3607 }
3608}
3609
Francis Murtagh1f7db452019-08-14 09:49:34 +01003610BOOST_AUTO_TEST_SUITE_END()