2 // Copyright © 2017 Arm Ltd. All rights reserved.
3 // SPDX-License-Identifier: MIT
6 #include "SendCounterPacket.hpp"
7 #include "EncodeVersion.hpp"
8 #include "ProfilingUtils.hpp"
10 #include <armnn/Exceptions.hpp>
11 #include <armnn/Conversion.hpp>
13 #include <boost/format.hpp>
14 #include <boost/numeric/conversion/cast.hpp>
15 #include <boost/core/ignore_unused.hpp>
25 using boost::numeric_cast;
27 const unsigned int SendCounterPacket::PIPE_MAGIC;
28 const unsigned int SendCounterPacket::MAX_METADATA_PACKET_LENGTH;
30 void SendCounterPacket::SendStreamMetaDataPacket()
32 std::string info(GetSoftwareInfo());
33 std::string hardwareVersion(GetHardwareVersion());
34 std::string softwareVersion(GetSoftwareVersion());
35 std::string processName = GetProcessName().substr(0, 60);
37 uint32_t infoSize = numeric_cast<uint32_t>(info.size()) > 0 ? numeric_cast<uint32_t>(info.size()) + 1 : 0;
38 uint32_t hardwareVersionSize = numeric_cast<uint32_t>(hardwareVersion.size()) > 0 ?
39 numeric_cast<uint32_t>(hardwareVersion.size()) + 1 : 0;
40 uint32_t softwareVersionSize = numeric_cast<uint32_t>(softwareVersion.size()) > 0 ?
41 numeric_cast<uint32_t>(softwareVersion.size()) + 1 : 0;
42 uint32_t processNameSize = numeric_cast<uint32_t>(processName.size()) > 0 ?
43 numeric_cast<uint32_t>(processName.size()) + 1 : 0;
45 uint32_t sizeUint32 = numeric_cast<uint32_t>(sizeof(uint32_t));
47 uint32_t headerSize = 2 * sizeUint32;
48 uint32_t bodySize = 10 * sizeUint32;
49 uint32_t packetVersionCountSize = sizeUint32;
52 // Stream metadata packet (packet family=0; packet id=0)
53 // Connection Acknowledged packet (packet family=0, packet id=1)
54 // Counter Directory packet (packet family=0; packet id=2)
55 // Request Counter Directory packet (packet family=0, packet id=3)
56 // Periodic Counter Selection packet (packet family=0, packet id=4)
57 // Periodic Counter Capture packet (packet family=1, packet class=0, type=0)
58 uint32_t packetVersionEntries = 6;
60 uint32_t payloadSize = numeric_cast<uint32_t>(infoSize + hardwareVersionSize + softwareVersionSize +
61 processNameSize + packetVersionCountSize +
62 (packetVersionEntries * 2 * sizeUint32));
64 uint32_t totalSize = headerSize + bodySize + payloadSize;
66 uint32_t reserved = 0;
68 std::unique_ptr<IPacketBuffer> writeBuffer = m_BufferManager.Reserve(totalSize, reserved);
70 if (writeBuffer == nullptr || reserved < totalSize)
72 CancelOperationAndThrow<BufferExhaustion>(
74 boost::str(boost::format("No space left in buffer. Unable to reserve (%1%) bytes.") % totalSize));
81 WriteUint32(writeBuffer, offset, 0);
83 WriteUint32(writeBuffer, offset, totalSize - headerSize);
88 WriteUint32(writeBuffer, offset, PIPE_MAGIC); // pipe_magic
90 WriteUint32(writeBuffer, offset, EncodeVersion(1, 0, 0)); // stream_metadata_version
92 WriteUint32(writeBuffer, offset, MAX_METADATA_PACKET_LENGTH); // max_data_length
94 WriteUint32(writeBuffer, offset, numeric_cast<uint32_t>(getpid())); // pid
96 uint32_t poolOffset = bodySize;
97 WriteUint32(writeBuffer, offset, infoSize ? poolOffset : 0); // offset_info
99 poolOffset += infoSize;
100 WriteUint32(writeBuffer, offset, hardwareVersionSize ? poolOffset : 0); // offset_hw_version
101 offset += sizeUint32;
102 poolOffset += hardwareVersionSize;
103 WriteUint32(writeBuffer, offset, softwareVersionSize ? poolOffset : 0); // offset_sw_version
104 offset += sizeUint32;
105 poolOffset += softwareVersionSize;
106 WriteUint32(writeBuffer, offset, processNameSize ? poolOffset : 0); // offset_process_name
107 offset += sizeUint32;
108 poolOffset += processNameSize;
109 WriteUint32(writeBuffer, offset, packetVersionEntries ? poolOffset : 0); // offset_packet_version_table
110 offset += sizeUint32;
111 WriteUint32(writeBuffer, offset, 0); // reserved
112 offset += sizeUint32;
118 memcpy(&writeBuffer->GetWritableData()[offset], info.c_str(), infoSize);
122 if (hardwareVersionSize)
124 memcpy(&writeBuffer->GetWritableData()[offset], hardwareVersion.c_str(), hardwareVersionSize);
125 offset += hardwareVersionSize;
128 if (softwareVersionSize)
130 memcpy(&writeBuffer->GetWritableData()[offset], softwareVersion.c_str(), softwareVersionSize);
131 offset += softwareVersionSize;
136 memcpy(&writeBuffer->GetWritableData()[offset], processName.c_str(), processNameSize);
137 offset += processNameSize;
140 if (packetVersionEntries)
142 // Packet Version Count
143 WriteUint32(writeBuffer, offset, packetVersionEntries << 16);
145 // Packet Version Entries
146 uint32_t packetFamily = 0;
147 uint32_t packetId = 0;
149 offset += sizeUint32;
150 for (uint32_t i = 0; i < packetVersionEntries - 1; ++i)
152 WriteUint32(writeBuffer, offset, ((packetFamily & 0x3F) << 26) | ((packetId++ & 0x3FF) << 16));
153 offset += sizeUint32;
154 WriteUint32(writeBuffer, offset, EncodeVersion(1, 0, 0));
155 offset += sizeUint32;
161 WriteUint32(writeBuffer, offset, ((packetFamily & 0x3F) << 26) | ((packetId & 0x3FF) << 16));
162 offset += sizeUint32;
163 WriteUint32(writeBuffer, offset, EncodeVersion(1, 0, 0));
168 CancelOperationAndThrow<RuntimeException>(writeBuffer, "Error processing packet.");
171 m_BufferManager.Commit(writeBuffer, totalSize);
174 bool SendCounterPacket::CreateCategoryRecord(const CategoryPtr& category,
175 const Counters& counters,
176 CategoryRecord& categoryRecord,
177 std::string& errorMessage)
179 using namespace boost::numeric;
181 BOOST_ASSERT(category);
183 const std::string& categoryName = category->m_Name;
184 const std::vector<uint16_t> categoryCounters = category->m_Counters;
185 uint16_t deviceUid = category->m_DeviceUid;
186 uint16_t counterSetUid = category->m_CounterSetUid;
188 BOOST_ASSERT(!categoryName.empty());
191 size_t uint32_t_size = sizeof(uint32_t);
193 // Category record word 0:
194 // 16:31 [16] device: the uid of a device element which identifies some hardware device that
195 // the category belongs to
196 // 0:15 [16] counter_set: the uid of a counter_set the category is associated with
197 uint32_t categoryRecordWord0 = (static_cast<uint32_t>(deviceUid) << 16) |
198 (static_cast<uint32_t>(counterSetUid));
200 // Category record word 1:
201 // 16:31 [16] event_count: number of events belonging to this category
202 // 0:15 [16] reserved: all zeros
203 uint32_t categoryRecordWord1 = static_cast<uint32_t>(categoryCounters.size()) << 16;
205 // Category record word 2:
206 // 0:31 [32] event_pointer_table_offset: offset from the beginning of the category data pool to
207 // the event_pointer_table
208 uint32_t categoryRecordWord2 = 0; // The offset is always zero here, as the event pointer table field is always
209 // the first item in the pool
211 // Convert the device name into a SWTrace namestring
212 std::vector<uint32_t> categoryNameBuffer;
213 if (!StringToSwTraceString<SwTraceNameCharPolicy>(categoryName, categoryNameBuffer))
215 errorMessage = boost::str(boost::format("Cannot convert the name of category \"%1%\" to an SWTrace namestring")
220 // Process the event records
221 size_t counterCount = categoryCounters.size();
222 std::vector<EventRecord> eventRecords(counterCount);
223 std::vector<uint32_t> eventRecordOffsets(counterCount, 0);
224 size_t eventRecordsSize = 0;
225 uint32_t eventRecordsOffset =
226 numeric_cast<uint32_t>((eventRecords.size() + categoryNameBuffer.size()) * uint32_t_size);
227 for (size_t counterIndex = 0, eventRecordIndex = 0, eventRecordOffsetIndex = 0;
228 counterIndex < counterCount;
229 counterIndex++, eventRecordIndex++, eventRecordOffsetIndex++)
231 uint16_t counterUid = categoryCounters.at(counterIndex);
232 auto it = counters.find(counterUid);
233 BOOST_ASSERT(it != counters.end());
234 const CounterPtr& counter = it->second;
236 EventRecord& eventRecord = eventRecords.at(eventRecordIndex);
237 if (!CreateEventRecord(counter, eventRecord, errorMessage))
242 // Update the total size in words of the event records
243 eventRecordsSize += eventRecord.size();
245 // Add the event record offset to the event pointer table offset field
246 eventRecordOffsets[eventRecordOffsetIndex] = eventRecordsOffset;
247 eventRecordsOffset += numeric_cast<uint32_t>(eventRecord.size() * uint32_t_size);
250 // Category record word 3:
251 // 0:31 [32] name_offset (offset from the beginning of the category data pool to the name field)
252 uint32_t categoryRecordWord3 = numeric_cast<uint32_t>(eventRecordOffsets.size() * uint32_t_size);
254 // Calculate the size in words of the category record
255 size_t categoryRecordSize = 4u + // The size of the fixed part (device + counter_set + event_count + reserved +
256 // event_pointer_table_offset + name_offset)
257 eventRecordOffsets.size() + // The size of the variable part (the event pointer table +
258 categoryNameBuffer.size() + // and the category name including the null-terminator +
259 eventRecordsSize; // the event records)
261 // Allocate the necessary space for the category record
262 categoryRecord.resize(categoryRecordSize);
264 ARMNN_NO_CONVERSION_WARN_BEGIN
265 // Create the category record
266 categoryRecord[0] = categoryRecordWord0; // device + counter_set
267 categoryRecord[1] = categoryRecordWord1; // event_count + reserved
268 categoryRecord[2] = categoryRecordWord2; // event_pointer_table_offset
269 categoryRecord[3] = categoryRecordWord3; // name_offset
270 auto offset = categoryRecord.begin() + 4u;
271 std::copy(eventRecordOffsets.begin(), eventRecordOffsets.end(), offset); // event_pointer_table
272 offset += eventRecordOffsets.size();
273 std::copy(categoryNameBuffer.begin(), categoryNameBuffer.end(), offset); // name
274 offset += categoryNameBuffer.size();
275 for (const EventRecord& eventRecord : eventRecords)
277 std::copy(eventRecord.begin(), eventRecord.end(), offset); // event_record
278 offset += eventRecord.size();
280 ARMNN_NO_CONVERSION_WARN_END
285 bool SendCounterPacket::CreateDeviceRecord(const DevicePtr& device,
286 DeviceRecord& deviceRecord,
287 std::string& errorMessage)
289 BOOST_ASSERT(device);
291 uint16_t deviceUid = device->m_Uid;
292 const std::string& deviceName = device->m_Name;
293 uint16_t deviceCores = device->m_Cores;
295 BOOST_ASSERT(!deviceName.empty());
297 // Device record word 0:
298 // 16:31 [16] uid: the unique identifier for the device
299 // 0:15 [16] cores: the number of individual streams of counters for one or more cores of some device
300 uint32_t deviceRecordWord0 = (static_cast<uint32_t>(deviceUid) << 16) |
301 (static_cast<uint32_t>(deviceCores));
303 // Device record word 1:
304 // 0:31 [32] name_offset: offset from the beginning of the device record pool to the name field
305 uint32_t deviceRecordWord1 = 0; // The offset is always zero here, as the name field is always
306 // the first (and only) item in the pool
308 // Convert the device name into a SWTrace string
309 std::vector<uint32_t> deviceNameBuffer;
310 if (!StringToSwTraceString<SwTraceCharPolicy>(deviceName, deviceNameBuffer))
312 errorMessage = boost::str(boost::format("Cannot convert the name of device %1% (\"%2%\") to an SWTrace string")
318 // Calculate the size in words of the device record
319 size_t deviceRecordSize = 2u + // The size of the fixed part (uid + cores + name_offset)
320 deviceNameBuffer.size(); // The size of the variable part (the device name including
321 // the null-terminator)
323 // Allocate the necessary space for the device record
324 deviceRecord.resize(deviceRecordSize);
326 // Create the device record
327 deviceRecord[0] = deviceRecordWord0; // uid + core
328 deviceRecord[1] = deviceRecordWord1; // name_offset
329 auto offset = deviceRecord.begin() + 2u;
330 std::copy(deviceNameBuffer.begin(), deviceNameBuffer.end(), offset); // name
335 bool SendCounterPacket::CreateCounterSetRecord(const CounterSetPtr& counterSet,
336 CounterSetRecord& counterSetRecord,
337 std::string& errorMessage)
339 BOOST_ASSERT(counterSet);
341 uint16_t counterSetUid = counterSet->m_Uid;
342 const std::string& counterSetName = counterSet->m_Name;
343 uint16_t counterSetCount = counterSet->m_Count;
345 BOOST_ASSERT(!counterSetName.empty());
347 // Counter set record word 0:
348 // 16:31 [16] uid: the unique identifier for the counter_set
349 // 0:15 [16] count: the number of counters which can be active in this set at any one time
350 uint32_t counterSetRecordWord0 = (static_cast<uint32_t>(counterSetUid) << 16) |
351 (static_cast<uint32_t>(counterSetCount));
353 // Counter set record word 1:
354 // 0:31 [32] name_offset: offset from the beginning of the counter set pool to the name field
355 uint32_t counterSetRecordWord1 = 0; // The offset is always zero here, as the name field is always
356 // the first (and only) item in the pool
358 // Convert the device name into a SWTrace namestring
359 std::vector<uint32_t> counterSetNameBuffer;
360 if (!StringToSwTraceString<SwTraceNameCharPolicy>(counterSet->m_Name, counterSetNameBuffer))
362 errorMessage = boost::str(boost::format("Cannot convert the name of counter set %1% (\"%2%\") to "
363 "an SWTrace namestring")
369 // Calculate the size in words of the counter set record
370 size_t counterSetRecordSize = 2u + // The size of the fixed part (uid + cores + name_offset)
371 counterSetNameBuffer.size(); // The size of the variable part (the counter set name
372 // including the null-terminator)
374 // Allocate the space for the counter set record
375 counterSetRecord.resize(counterSetRecordSize);
377 // Create the counter set record
378 counterSetRecord[0] = counterSetRecordWord0; // uid + core
379 counterSetRecord[1] = counterSetRecordWord1; // name_offset
380 auto offset = counterSetRecord.begin() + 2u;
381 std::copy(counterSetNameBuffer.begin(), counterSetNameBuffer.end(), offset); // name
386 bool SendCounterPacket::CreateEventRecord(const CounterPtr& counter,
387 EventRecord& eventRecord,
388 std::string& errorMessage)
390 using namespace boost::numeric;
392 BOOST_ASSERT(counter);
394 uint16_t counterUid = counter->m_Uid;
395 uint16_t maxCounterUid = counter->m_MaxCounterUid;
396 uint16_t deviceUid = counter->m_DeviceUid;
397 uint16_t counterSetUid = counter->m_CounterSetUid;
398 uint16_t counterClass = counter->m_Class;
399 uint16_t counterInterpolation = counter->m_Interpolation;
400 double counterMultiplier = counter->m_Multiplier;
401 const std::string& counterName = counter->m_Name;
402 const std::string& counterDescription = counter->m_Description;
403 const std::string& counterUnits = counter->m_Units;
405 BOOST_ASSERT(counterClass == 0 || counterClass == 1);
406 BOOST_ASSERT(counterInterpolation == 0 || counterInterpolation == 1);
407 BOOST_ASSERT(counterMultiplier);
410 size_t uint32_t_size = sizeof(uint32_t);
412 // Event record word 0:
413 // 16:31 [16] max_counter_uid: if the device this event is associated with has more than one core and there
414 // is one of these counters per core this value will be set to
415 // (counter_uid + cores (from device_record)) - 1.
416 // If there is only a single core then this value will be the same as
417 // the counter_uid value
418 // 0:15 [16] count_uid: unique ID for the counter. Must be unique across all counters in all categories
419 uint32_t eventRecordWord0 = (static_cast<uint32_t>(maxCounterUid) << 16) |
420 (static_cast<uint32_t>(counterUid));
422 // Event record word 1:
423 // 16:31 [16] device: UID of the device this event is associated with. Set to zero if the event is NOT
424 // associated with a device
425 // 0:15 [16] counter_set: UID of the counter_set this event is associated with. Set to zero if the event
426 // is NOT associated with a counter_set
427 uint32_t eventRecordWord1 = (static_cast<uint32_t>(deviceUid) << 16) |
428 (static_cast<uint32_t>(counterSetUid));
430 // Event record word 2:
431 // 16:31 [16] class: type describing how to treat each data point in a stream of data points
432 // 0:15 [16] interpolation: type describing how to interpolate each data point in a stream of data points
433 uint32_t eventRecordWord2 = (static_cast<uint32_t>(counterClass) << 16) |
434 (static_cast<uint32_t>(counterInterpolation));
436 // Event record word 3-4:
437 // 0:63 [64] multiplier: internal data stream is represented as integer values, this allows scaling of
438 // those values as if they are fixed point numbers. Zero is not a valid value
439 uint32_t multiplier[2] = { 0u, 0u };
440 BOOST_ASSERT(sizeof(counterMultiplier) == sizeof(multiplier));
441 std::memcpy(multiplier, &counterMultiplier, sizeof(multiplier));
442 uint32_t eventRecordWord3 = multiplier[0];
443 uint32_t eventRecordWord4 = multiplier[1];
445 // Event record word 5:
446 // 0:31 [32] name_offset: offset from the beginning of the event record pool to the name field
447 uint32_t eventRecordWord5 = 0; // The offset is always zero here, as the name field is always
448 // the first item in the pool
450 // Convert the counter name into a SWTrace string
451 std::vector<uint32_t> counterNameBuffer;
452 if (!StringToSwTraceString<SwTraceCharPolicy>(counterName, counterNameBuffer))
454 errorMessage = boost::str(boost::format("Cannot convert the name of counter %1% (name: \"%2%\") "
455 "to an SWTrace string")
461 // Event record word 6:
462 // 0:31 [32] description_offset: offset from the beginning of the event record pool to the description field
463 // The size of the name buffer in bytes
464 uint32_t eventRecordWord6 = numeric_cast<uint32_t>(counterNameBuffer.size() * uint32_t_size);
466 // Convert the counter description into a SWTrace string
467 std::vector<uint32_t> counterDescriptionBuffer;
468 if (!StringToSwTraceString<SwTraceCharPolicy>(counterDescription, counterDescriptionBuffer))
470 errorMessage = boost::str(boost::format("Cannot convert the description of counter %1% (description: \"%2%\") "
471 "to an SWTrace string")
477 // Event record word 7:
478 // 0:31 [32] units_offset: (optional) offset from the beginning of the event record pool to the units field.
479 // An offset value of zero indicates this field is not provided
480 bool includeUnits = !counterUnits.empty();
481 // The size of the description buffer in bytes
482 uint32_t eventRecordWord7 = includeUnits ?
484 numeric_cast<uint32_t>(counterDescriptionBuffer.size() * uint32_t_size) :
487 // Convert the counter units into a SWTrace namestring (optional)
488 std::vector<uint32_t> counterUnitsBuffer;
491 // Convert the counter units into a SWTrace namestring
492 if (!StringToSwTraceString<SwTraceNameCharPolicy>(counterUnits, counterUnitsBuffer))
494 errorMessage = boost::str(boost::format("Cannot convert the units of counter %1% (units: \"%2%\") "
495 "to an SWTrace string")
502 // Calculate the size in words of the event record
503 size_t eventRecordSize = 8u + // The size of the fixed part (counter_uid + max_counter_uid + device +
504 // counter_set + class + interpolation +
505 // multiplier + name_offset + description_offset +
507 counterNameBuffer.size() + // The size of the variable part (the counter name,
508 counterDescriptionBuffer.size() + // description and units including the null-terminator)
509 counterUnitsBuffer.size();
511 // Allocate the space for the event record
512 eventRecord.resize(eventRecordSize);
514 ARMNN_NO_CONVERSION_WARN_BEGIN
515 // Create the event record
516 eventRecord[0] = eventRecordWord0; // max_counter_uid + counter_uid
517 eventRecord[1] = eventRecordWord1; // device + counter_set
518 eventRecord[2] = eventRecordWord2; // class + interpolation
519 eventRecord[3] = eventRecordWord3; // multiplier
520 eventRecord[4] = eventRecordWord4; // multiplier
521 eventRecord[5] = eventRecordWord5; // name_offset
522 eventRecord[6] = eventRecordWord6; // description_offset
523 eventRecord[7] = eventRecordWord7; // units_offset
524 auto offset = eventRecord.begin() + 8u;
525 std::copy(counterNameBuffer.begin(), counterNameBuffer.end(), offset); // name
526 offset += counterNameBuffer.size();
527 std::copy(counterDescriptionBuffer.begin(), counterDescriptionBuffer.end(), offset); // description
530 offset += counterDescriptionBuffer.size();
531 std::copy(counterUnitsBuffer.begin(), counterUnitsBuffer.end(), offset); // units
533 ARMNN_NO_CONVERSION_WARN_END
538 void SendCounterPacket::SendCounterDirectoryPacket(const ICounterDirectory& counterDirectory)
540 using namespace boost::numeric;
542 // Get the amount of data that needs to be put into the packet
543 uint16_t categoryCount = counterDirectory.GetCategoryCount();
544 uint16_t deviceCount = counterDirectory.GetDeviceCount();
545 uint16_t counterSetCount = counterDirectory.GetCounterSetCount();
548 size_t uint32_t_size = sizeof(uint32_t);
549 size_t packetHeaderSize = 2u;
550 size_t bodyHeaderSize = 6u;
552 // Initialize the offset for the pointer tables
553 uint32_t pointerTableOffset = 0;
559 // Process device records
560 std::vector<DeviceRecord> deviceRecords(deviceCount);
561 const Devices& devices = counterDirectory.GetDevices();
562 std::vector<uint32_t> deviceRecordOffsets(deviceCount, 0); // device_records_pointer_table
563 size_t deviceRecordsSize = 0;
564 size_t deviceIndex = 0;
565 size_t deviceRecordOffsetIndex = 0;
566 for (auto it = devices.begin(); it != devices.end(); it++)
568 const DevicePtr& device = it->second;
569 DeviceRecord& deviceRecord = deviceRecords.at(deviceIndex);
571 std::string errorMessage;
572 if (!CreateDeviceRecord(device, deviceRecord, errorMessage))
574 CancelOperationAndThrow<RuntimeException>(errorMessage);
577 // Update the total size in words of the device records
578 deviceRecordsSize += deviceRecord.size();
580 // Add the device record offset to the device records pointer table offset field
581 deviceRecordOffsets[deviceRecordOffsetIndex] = pointerTableOffset;
582 pointerTableOffset += numeric_cast<uint32_t>(deviceRecord.size() * uint32_t_size);
585 deviceRecordOffsetIndex++;
588 // -------------------
589 // Counter set records
590 // -------------------
592 // Process counter set records
593 std::vector<CounterSetRecord> counterSetRecords(counterSetCount);
594 const CounterSets& counterSets = counterDirectory.GetCounterSets();
595 std::vector<uint32_t> counterSetRecordOffsets(counterSetCount, 0); // counter_set_records_pointer_table
596 size_t counterSetRecordsSize = 0;
597 size_t counterSetIndex = 0;
598 size_t counterSetRecordOffsetIndex = 0;
599 for (auto it = counterSets.begin(); it != counterSets.end(); it++)
601 const CounterSetPtr& counterSet = it->second;
602 CounterSetRecord& counterSetRecord = counterSetRecords.at(counterSetIndex);
604 std::string errorMessage;
605 if (!CreateCounterSetRecord(counterSet, counterSetRecord, errorMessage))
607 CancelOperationAndThrow<RuntimeException>(errorMessage);
610 // Update the total size in words of the counter set records
611 counterSetRecordsSize += counterSetRecord.size();
613 // Add the counter set record offset to the counter set records pointer table offset field
614 counterSetRecordOffsets[counterSetRecordOffsetIndex] = pointerTableOffset;
615 pointerTableOffset += numeric_cast<uint32_t>(counterSetRecord.size() * uint32_t_size);
618 counterSetRecordOffsetIndex++;
625 // Process category records
626 std::vector<CategoryRecord> categoryRecords(categoryCount);
627 const Categories& categories = counterDirectory.GetCategories();
628 std::vector<uint32_t> categoryRecordOffsets(categoryCount, 0); // category_records_pointer_table
629 size_t categoryRecordsSize = 0;
630 size_t categoryIndex = 0;
631 size_t categoryRecordOffsetIndex = 0;
632 for (auto it = categories.begin(); it != categories.end(); it++)
634 const CategoryPtr& category = *it;
635 CategoryRecord& categoryRecord = categoryRecords.at(categoryIndex);
637 std::string errorMessage;
638 if (!CreateCategoryRecord(category, counterDirectory.GetCounters(), categoryRecord, errorMessage))
640 CancelOperationAndThrow<RuntimeException>(errorMessage);
643 // Update the total size in words of the category records
644 categoryRecordsSize += categoryRecord.size();
646 // Add the category record offset to the category records pointer table offset field
647 categoryRecordOffsets[categoryRecordOffsetIndex] = pointerTableOffset;
648 pointerTableOffset += numeric_cast<uint32_t>(categoryRecord.size() * uint32_t_size);
651 categoryRecordOffsetIndex++;
656 // Calculate the length in words of the counter directory packet's data (excludes the packet header size)
657 size_t counterDirectoryPacketDataLength =
658 bodyHeaderSize + // The size of the body header
659 deviceRecordOffsets.size() + // The size of the device records pointer table
660 counterSetRecordOffsets.size() + // The size of counter set pointer table
661 categoryRecordOffsets.size() + // The size of category records pointer table
662 deviceRecordsSize + // The total size of the device records
663 counterSetRecordsSize + // The total size of the counter set records
664 categoryRecordsSize; // The total size of the category records
666 // Calculate the size in words of the counter directory packet (the data length plus the packet header size)
667 size_t counterDirectoryPacketSize = packetHeaderSize + // The size of the packet header
668 counterDirectoryPacketDataLength; // The data length
671 // Allocate the necessary space for the counter directory packet
672 std::vector<uint32_t> counterDirectoryPacket(counterDirectoryPacketSize, 0);
678 // Packet header word 0:
679 // 26:31 [6] packet_family: control Packet Family
680 // 16:25 [10] packet_id: packet identifier
681 // 8:15 [8] reserved: all zeros
682 // 0:7 [8] reserved: all zeros
683 uint32_t packetFamily = 0;
684 uint32_t packetId = 2;
685 uint32_t packetHeaderWord0 = ((packetFamily & 0x3F) << 26) | ((packetId & 0x3FF) << 16);
687 // Packet header word 1:
688 // 0:31 [32] data_length: length of data, in bytes
689 uint32_t packetHeaderWord1 = numeric_cast<uint32_t>(counterDirectoryPacketDataLength * uint32_t_size);
691 // Create the packet header
692 uint32_t packetHeader[2]
694 packetHeaderWord0, // packet_family + packet_id + reserved + reserved
695 packetHeaderWord1 // data_length
702 // Body header word 0:
703 // 16:31 [16] device_records_count: number of entries in the device_records_pointer_table
704 // 0:15 [16] reserved: all zeros
705 uint32_t bodyHeaderWord0 = static_cast<uint32_t>(deviceCount) << 16;
707 // Body header word 1:
708 // 0:31 [32] device_records_pointer_table_offset: offset to the device_records_pointer_table
709 uint32_t bodyHeaderWord1 = 0; // The offset is always zero here, as the device record pointer table field is always
710 // the first item in the pool
712 // Body header word 2:
713 // 16:31 [16] counter_set_count: number of entries in the counter_set_pointer_table
714 // 0:15 [16] reserved: all zeros
715 uint32_t bodyHeaderWord2 = static_cast<uint32_t>(counterSetCount) << 16;
717 // Body header word 3:
718 // 0:31 [32] counter_set_pointer_table_offset: offset to the counter_set_pointer_table
719 uint32_t bodyHeaderWord3 =
720 numeric_cast<uint32_t>(deviceRecordOffsets.size() * uint32_t_size); // The size of the device records
724 // Body header word 4:
725 // 16:31 [16] categories_count: number of entries in the categories_pointer_table
726 // 0:15 [16] reserved: all zeros
727 uint32_t bodyHeaderWord4 = static_cast<uint32_t>(categoryCount) << 16;
729 // Body header word 3:
730 // 0:31 [32] categories_pointer_table_offset: offset to the categories_pointer_table
731 uint32_t bodyHeaderWord5 =
732 numeric_cast<uint32_t>(deviceRecordOffsets.size() * uint32_t_size + // The size of the device records
733 counterSetRecordOffsets.size() * uint32_t_size); // pointer table, plus the size of
734 // the counter set pointer table
736 // Create the body header
737 uint32_t bodyHeader[6]
739 bodyHeaderWord0, // device_records_count + reserved
740 bodyHeaderWord1, // device_records_pointer_table_offset
741 bodyHeaderWord2, // counter_set_count + reserved
742 bodyHeaderWord3, // counter_set_pointer_table_offset
743 bodyHeaderWord4, // categories_count + reserved
744 bodyHeaderWord5 // categories_pointer_table_offset
747 ARMNN_NO_CONVERSION_WARN_BEGIN
748 // Create the counter directory packet
749 auto counterDirectoryPacketOffset = counterDirectoryPacket.begin();
751 std::copy(packetHeader, packetHeader + packetHeaderSize, counterDirectoryPacketOffset);
752 counterDirectoryPacketOffset += packetHeaderSize;
754 std::copy(bodyHeader, bodyHeader + bodyHeaderSize, counterDirectoryPacketOffset);
755 counterDirectoryPacketOffset += bodyHeaderSize;
756 // device_records_pointer_table
757 std::copy(deviceRecordOffsets.begin(), deviceRecordOffsets.end(), counterDirectoryPacketOffset);
758 counterDirectoryPacketOffset += deviceRecordOffsets.size();
759 // counter_set_pointer_table
760 std::copy(counterSetRecordOffsets.begin(), counterSetRecordOffsets.end(), counterDirectoryPacketOffset);
761 counterDirectoryPacketOffset += counterSetRecordOffsets.size();
762 // category_pointer_table
763 std::copy(categoryRecordOffsets.begin(), categoryRecordOffsets.end(), counterDirectoryPacketOffset);
764 counterDirectoryPacketOffset += categoryRecordOffsets.size();
766 for (const DeviceRecord& deviceRecord : deviceRecords)
768 std::copy(deviceRecord.begin(), deviceRecord.end(), counterDirectoryPacketOffset); // device_record
769 counterDirectoryPacketOffset += deviceRecord.size();
771 // counter_set_records
772 for (const CounterSetRecord& counterSetRecord : counterSetRecords)
774 std::copy(counterSetRecord.begin(), counterSetRecord.end(), counterDirectoryPacketOffset); // counter_set_record
775 counterDirectoryPacketOffset += counterSetRecord.size();
778 for (const CategoryRecord& categoryRecord : categoryRecords)
780 std::copy(categoryRecord.begin(), categoryRecord.end(), counterDirectoryPacketOffset); // category_record
781 counterDirectoryPacketOffset += categoryRecord.size();
783 ARMNN_NO_CONVERSION_WARN_END
785 // Calculate the total size in bytes of the counter directory packet
786 uint32_t totalSize = numeric_cast<uint32_t>(counterDirectoryPacketSize * uint32_t_size);
788 // Reserve space in the buffer for the packet
789 uint32_t reserved = 0;
790 std::unique_ptr<IPacketBuffer> writeBuffer = m_BufferManager.Reserve(totalSize, reserved);
792 if (writeBuffer == nullptr || reserved < totalSize)
794 CancelOperationAndThrow<BufferExhaustion>(
796 boost::str(boost::format("No space left in buffer. Unable to reserve (%1%) bytes.") % totalSize));
799 // Offset for writing to the buffer
802 // Write the counter directory packet to the buffer
803 for (uint32_t counterDirectoryPacketWord : counterDirectoryPacket)
805 WriteUint32(writeBuffer, offset, counterDirectoryPacketWord);
806 offset += numeric_cast<uint32_t>(uint32_t_size);
809 m_BufferManager.Commit(writeBuffer, totalSize);
812 void SendCounterPacket::SendPeriodicCounterCapturePacket(uint64_t timestamp, const IndexValuePairsVector& values)
814 uint32_t packetFamily = 1;
815 uint32_t packetClass = 0;
816 uint32_t packetType = 0;
817 uint32_t headerSize = numeric_cast<uint32_t>(2 * sizeof(uint32_t));
818 uint32_t bodySize = numeric_cast<uint32_t>((1 * sizeof(uint64_t)) +
819 (values.size() * (sizeof(uint16_t) + sizeof(uint32_t))));
820 uint32_t totalSize = headerSize + bodySize;
822 uint32_t reserved = 0;
824 std::unique_ptr<IPacketBuffer> writeBuffer = m_BufferManager.Reserve(totalSize, reserved);
826 if (writeBuffer == nullptr || reserved < totalSize)
828 CancelOperationAndThrow<BufferExhaustion>(
830 boost::str(boost::format("No space left in buffer. Unable to reserve (%1%) bytes.") % totalSize));
834 WriteUint32(writeBuffer,
836 ((packetFamily & 0x3F) << 26) | ((packetClass & 0x3FF) << 19) | ((packetType & 0x3FFF) << 16));
837 offset += numeric_cast<uint32_t>(sizeof(uint32_t));
838 WriteUint32(writeBuffer, offset, bodySize);
840 // Copy captured Timestamp.
841 offset += numeric_cast<uint32_t>(sizeof(uint32_t));
842 WriteUint64(writeBuffer, offset, timestamp);
844 // Copy selectedCounterIds.
845 offset += numeric_cast<uint32_t>(sizeof(uint64_t));
846 for (const auto& pair: values)
848 WriteUint16(writeBuffer, offset, pair.first);
849 offset += numeric_cast<uint32_t>(sizeof(uint16_t));
850 WriteUint32(writeBuffer, offset, pair.second);
851 offset += numeric_cast<uint32_t>(sizeof(uint32_t));
854 m_BufferManager.Commit(writeBuffer, totalSize);
857 void SendCounterPacket::SendPeriodicCounterSelectionPacket(uint32_t capturePeriod,
858 const std::vector<uint16_t>& selectedCounterIds)
860 uint32_t packetFamily = 0;
861 uint32_t packetId = 4;
862 uint32_t headerSize = numeric_cast<uint32_t>(2 * sizeof(uint32_t));
863 uint32_t bodySize = numeric_cast<uint32_t>((1 * sizeof(uint32_t)) +
864 (selectedCounterIds.size() * sizeof(uint16_t)));
865 uint32_t totalSize = headerSize + bodySize;
867 uint32_t reserved = 0;
869 std::unique_ptr<IPacketBuffer> writeBuffer = m_BufferManager.Reserve(totalSize, reserved);
871 if (writeBuffer == nullptr || reserved < totalSize)
873 CancelOperationAndThrow<BufferExhaustion>(
875 boost::str(boost::format("No space left in buffer. Unable to reserve (%1%) bytes.") % totalSize));
879 WriteUint32(writeBuffer, offset, ((packetFamily & 0x3F) << 26) | ((packetId & 0x3FF) << 16));
880 offset += numeric_cast<uint32_t>(sizeof(uint32_t));
881 WriteUint32(writeBuffer, offset, bodySize);
883 // Copy capturePeriod.
884 offset += numeric_cast<uint32_t>(sizeof(uint32_t));
885 WriteUint32(writeBuffer, offset, capturePeriod);
887 // Copy selectedCounterIds.
888 offset += numeric_cast<uint32_t>(sizeof(uint32_t));
889 for(const uint16_t& id: selectedCounterIds)
891 WriteUint16(writeBuffer, offset, id);
892 offset += numeric_cast<uint32_t>(sizeof(uint16_t));
895 m_BufferManager.Commit(writeBuffer, totalSize);
898 void SendCounterPacket::SetReadyToRead()
900 // Signal the send thread that there's something to read in the buffer
901 m_WaitCondition.notify_one();
904 void SendCounterPacket::Start()
906 // Check if the send thread is already running
907 if (m_IsRunning.load())
909 // The send thread is already running
913 // Mark the send thread as running
914 m_IsRunning.store(true);
916 // Keep the send procedure going until the send thread is signalled to stop
917 m_KeepRunning.store(true);
919 // Start the send thread
920 m_SendThread = std::thread(&SendCounterPacket::Send, this);
923 void SendCounterPacket::Stop()
925 // Signal the send thread to stop
926 m_KeepRunning.store(false);
928 // Check that the send thread is running
929 if (m_SendThread.joinable())
931 // Kick the send thread out of the wait condition
932 m_WaitCondition.notify_one();
934 // Wait for the send thread to complete operations
939 void SendCounterPacket::Send()
941 // Keep the sending procedure looping until the thread is signalled to stop
942 while (m_KeepRunning.load())
944 // Wait condition lock scope - Begin
946 // Lock the mutex to wait on it
947 std::unique_lock<std::mutex> lock(m_WaitMutex);
951 // Wait indefinitely until notified that something to read has become available in the buffer
952 m_WaitCondition.wait(lock);
956 // Wait until the thread is notified of something to read from the buffer,
957 // or check anyway after a second
958 m_WaitCondition.wait_for(lock, std::chrono::seconds(m_Timeout));
961 // Wait condition lock scope - End
966 // Ensure that all readable data got written to the profiling connection before the thread is stopped
969 // Mark the send thread as not running
970 m_IsRunning.store(false);
973 void SendCounterPacket::FlushBuffer()
975 // Get the first available readable buffer
976 std::unique_ptr<IPacketBuffer> packetBuffer = m_BufferManager.GetReadableBuffer();
978 while (packetBuffer != nullptr)
980 // Get the data to send from the buffer
981 const unsigned char* readBuffer = packetBuffer->GetReadableData();
982 unsigned int readBufferSize = packetBuffer->GetSize();
984 if (readBuffer == nullptr || readBufferSize == 0)
986 // Nothing to send, get the next available readable buffer and continue
987 m_BufferManager.MarkRead(packetBuffer);
988 packetBuffer = m_BufferManager.GetReadableBuffer();
993 // Check that the profiling connection is open, silently drop the data and continue if it's closed
994 if (m_ProfilingConnection.IsOpen())
996 // Write a packet to the profiling connection. Silently ignore any write error and continue
997 m_ProfilingConnection.WritePacket(readBuffer, boost::numeric_cast<uint32_t>(readBufferSize));
1000 // Mark the packet buffer as read
1001 m_BufferManager.MarkRead(packetBuffer);
1003 // Get next available readable buffer
1004 packetBuffer = m_BufferManager.GetReadableBuffer();
1008 } // namespace profiling
1010 } // namespace armnn