blob: 382f958fca0f90cd2eef55c91c857f59840d4582 [file] [log] [blame]
//
// Copyright © 2017 Arm Ltd. All rights reserved.
// SPDX-License-Identifier: MIT
//
#include "SendCounterPacket.hpp"
#include "EncodeVersion.hpp"
#include "ProfilingUtils.hpp"
#include <armnn/Exceptions.hpp>
#include <armnn/Conversion.hpp>
#include <boost/format.hpp>
#include <boost/numeric/conversion/cast.hpp>
#include <boost/core/ignore_unused.hpp>
#include <cstring>
namespace armnn
{
namespace profiling
{
using boost::numeric_cast;
const unsigned int SendCounterPacket::PIPE_MAGIC;
void SendCounterPacket::SendStreamMetaDataPacket()
{
std::string info(GetSoftwareInfo());
std::string hardwareVersion(GetHardwareVersion());
std::string softwareVersion(GetSoftwareVersion());
std::string processName = GetProcessName().substr(0, 60);
uint32_t infoSize = numeric_cast<uint32_t>(info.size()) > 0 ? numeric_cast<uint32_t>(info.size()) + 1 : 0;
uint32_t hardwareVersionSize = numeric_cast<uint32_t>(hardwareVersion.size()) > 0 ?
numeric_cast<uint32_t>(hardwareVersion.size()) + 1 : 0;
uint32_t softwareVersionSize = numeric_cast<uint32_t>(softwareVersion.size()) > 0 ?
numeric_cast<uint32_t>(softwareVersion.size()) + 1 : 0;
uint32_t processNameSize = numeric_cast<uint32_t>(processName.size()) > 0 ?
numeric_cast<uint32_t>(processName.size()) + 1 : 0;
uint32_t sizeUint32 = numeric_cast<uint32_t>(sizeof(uint32_t));
uint32_t headerSize = 2 * sizeUint32;
uint32_t bodySize = 10 * sizeUint32;
uint32_t packetVersionCountSize = sizeUint32;
// Supported Packets
// Stream metadata packet (packet family=0; packet id=0)
// Connection Acknowledged packet (packet family=0, packet id=1)
// Counter Directory packet (packet family=0; packet id=2)
// Request Counter Directory packet (packet family=0, packet id=3)
// Periodic Counter Selection packet (packet family=0, packet id=4)
// Periodic Counter Capture packet (packet family=1, packet class=0, type=0)
uint32_t packetVersionEntries = 6;
uint32_t payloadSize = numeric_cast<uint32_t>(infoSize + hardwareVersionSize + softwareVersionSize +
processNameSize + packetVersionCountSize +
(packetVersionEntries * 2 * sizeUint32));
uint32_t totalSize = headerSize + bodySize + payloadSize;
uint32_t offset = 0;
uint32_t reserved = 0;
std::unique_ptr<IPacketBuffer> writeBuffer = m_BufferManager.Reserve(totalSize, reserved);
if (writeBuffer == nullptr || reserved < totalSize)
{
CancelOperationAndThrow<BufferExhaustion>(
writeBuffer,
boost::str(boost::format("No space left in buffer. Unable to reserve (%1%) bytes.") % totalSize));
}
try
{
// Create header
WriteUint32(writeBuffer, offset, 0);
offset += sizeUint32;
WriteUint32(writeBuffer, offset, totalSize - headerSize);
// Packet body
offset += sizeUint32;
WriteUint32(writeBuffer, offset, PIPE_MAGIC); // pipe_magic
offset += sizeUint32;
WriteUint32(writeBuffer, offset, EncodeVersion(1, 0, 0)); // stream_metadata_version
offset += sizeUint32;
WriteUint32(writeBuffer, offset, MAX_METADATA_PACKET_LENGTH); // max_data_length
offset += sizeUint32;
WriteUint32(writeBuffer, offset, numeric_cast<uint32_t>(getpid())); // pid
offset += sizeUint32;
uint32_t poolOffset = bodySize;
WriteUint32(writeBuffer, offset, infoSize ? poolOffset : 0); // offset_info
offset += sizeUint32;
poolOffset += infoSize;
WriteUint32(writeBuffer, offset, hardwareVersionSize ? poolOffset : 0); // offset_hw_version
offset += sizeUint32;
poolOffset += hardwareVersionSize;
WriteUint32(writeBuffer, offset, softwareVersionSize ? poolOffset : 0); // offset_sw_version
offset += sizeUint32;
poolOffset += softwareVersionSize;
WriteUint32(writeBuffer, offset, processNameSize ? poolOffset : 0); // offset_process_name
offset += sizeUint32;
poolOffset += processNameSize;
WriteUint32(writeBuffer, offset, packetVersionEntries ? poolOffset : 0); // offset_packet_version_table
offset += sizeUint32;
WriteUint32(writeBuffer, offset, 0); // reserved
offset += sizeUint32;
// Pool
if (infoSize)
{
memcpy(&writeBuffer->GetWritableData()[offset], info.c_str(), infoSize);
offset += infoSize;
}
if (hardwareVersionSize)
{
memcpy(&writeBuffer->GetWritableData()[offset], hardwareVersion.c_str(), hardwareVersionSize);
offset += hardwareVersionSize;
}
if (softwareVersionSize)
{
memcpy(&writeBuffer->GetWritableData()[offset], softwareVersion.c_str(), softwareVersionSize);
offset += softwareVersionSize;
}
if (processNameSize)
{
memcpy(&writeBuffer->GetWritableData()[offset], processName.c_str(), processNameSize);
offset += processNameSize;
}
if (packetVersionEntries)
{
// Packet Version Count
WriteUint32(writeBuffer, offset, packetVersionEntries << 16);
// Packet Version Entries
uint32_t packetFamily = 0;
uint32_t packetId = 0;
offset += sizeUint32;
for (uint32_t i = 0; i < packetVersionEntries - 1; ++i)
{
WriteUint32(writeBuffer, offset, ((packetFamily & 0x3F) << 26) | ((packetId++ & 0x3FF) << 16));
offset += sizeUint32;
WriteUint32(writeBuffer, offset, EncodeVersion(1, 0, 0));
offset += sizeUint32;
}
packetFamily = 1;
packetId = 0;
WriteUint32(writeBuffer, offset, ((packetFamily & 0x3F) << 26) | ((packetId & 0x3FF) << 16));
offset += sizeUint32;
WriteUint32(writeBuffer, offset, EncodeVersion(1, 0, 0));
}
}
catch(...)
{
CancelOperationAndThrow<RuntimeException>(writeBuffer, "Error processing packet.");
}
m_BufferManager.Commit(writeBuffer, totalSize);
}
bool SendCounterPacket::CreateCategoryRecord(const CategoryPtr& category,
const Counters& counters,
CategoryRecord& categoryRecord,
std::string& errorMessage)
{
using namespace boost::numeric;
BOOST_ASSERT(category);
const std::string& categoryName = category->m_Name;
const std::vector<uint16_t> categoryCounters = category->m_Counters;
uint16_t deviceUid = category->m_DeviceUid;
uint16_t counterSetUid = category->m_CounterSetUid;
BOOST_ASSERT(!categoryName.empty());
// Utils
size_t uint32_t_size = sizeof(uint32_t);
// Category record word 0:
// 16:31 [16] device: the uid of a device element which identifies some hardware device that
// the category belongs to
// 0:15 [16] counter_set: the uid of a counter_set the category is associated with
uint32_t categoryRecordWord0 = (static_cast<uint32_t>(deviceUid) << 16) |
(static_cast<uint32_t>(counterSetUid));
// Category record word 1:
// 16:31 [16] event_count: number of events belonging to this category
// 0:15 [16] reserved: all zeros
uint32_t categoryRecordWord1 = static_cast<uint32_t>(categoryCounters.size()) << 16;
// Category record word 2:
// 0:31 [32] event_pointer_table_offset: offset from the beginning of the category data pool to
// the event_pointer_table
uint32_t categoryRecordWord2 = 0; // The offset is always zero here, as the event pointer table field is always
// the first item in the pool
// Convert the device name into a SWTrace namestring
std::vector<uint32_t> categoryNameBuffer;
if (!StringToSwTraceString<SwTraceNameCharPolicy>(categoryName, categoryNameBuffer))
{
errorMessage = boost::str(boost::format("Cannot convert the name of category \"%1%\" to an SWTrace namestring")
% categoryName);
return false;
}
// Process the event records
size_t counterCount = categoryCounters.size();
std::vector<EventRecord> eventRecords(counterCount);
std::vector<uint32_t> eventRecordOffsets(counterCount, 0);
size_t eventRecordsSize = 0;
uint32_t eventRecordsOffset =
numeric_cast<uint32_t>((eventRecords.size() + categoryNameBuffer.size()) * uint32_t_size);
for (size_t counterIndex = 0, eventRecordIndex = 0, eventRecordOffsetIndex = 0;
counterIndex < counterCount;
counterIndex++, eventRecordIndex++, eventRecordOffsetIndex++)
{
uint16_t counterUid = categoryCounters.at(counterIndex);
auto it = counters.find(counterUid);
BOOST_ASSERT(it != counters.end());
const CounterPtr& counter = it->second;
EventRecord& eventRecord = eventRecords.at(eventRecordIndex);
if (!CreateEventRecord(counter, eventRecord, errorMessage))
{
return false;
}
// Update the total size in words of the event records
eventRecordsSize += eventRecord.size();
// Add the event record offset to the event pointer table offset field
eventRecordOffsets[eventRecordOffsetIndex] = eventRecordsOffset;
eventRecordsOffset += numeric_cast<uint32_t>(eventRecord.size() * uint32_t_size);
}
// Category record word 3:
// 0:31 [32] name_offset (offset from the beginning of the category data pool to the name field)
uint32_t categoryRecordWord3 = numeric_cast<uint32_t>(eventRecordOffsets.size() * uint32_t_size);
// Calculate the size in words of the category record
size_t categoryRecordSize = 4u + // The size of the fixed part (device + counter_set + event_count + reserved +
// event_pointer_table_offset + name_offset)
eventRecordOffsets.size() + // The size of the variable part (the event pointer table +
categoryNameBuffer.size() + // and the category name including the null-terminator +
eventRecordsSize; // the event records)
// Allocate the necessary space for the category record
categoryRecord.resize(categoryRecordSize);
ARMNN_NO_CONVERSION_WARN_BEGIN
// Create the category record
categoryRecord[0] = categoryRecordWord0; // device + counter_set
categoryRecord[1] = categoryRecordWord1; // event_count + reserved
categoryRecord[2] = categoryRecordWord2; // event_pointer_table_offset
categoryRecord[3] = categoryRecordWord3; // name_offset
auto offset = categoryRecord.begin() + 4u;
std::copy(eventRecordOffsets.begin(), eventRecordOffsets.end(), offset); // event_pointer_table
offset += eventRecordOffsets.size();
std::copy(categoryNameBuffer.begin(), categoryNameBuffer.end(), offset); // name
offset += categoryNameBuffer.size();
for (const EventRecord& eventRecord : eventRecords)
{
std::copy(eventRecord.begin(), eventRecord.end(), offset); // event_record
offset += eventRecord.size();
}
ARMNN_NO_CONVERSION_WARN_END
return true;
}
bool SendCounterPacket::CreateDeviceRecord(const DevicePtr& device,
DeviceRecord& deviceRecord,
std::string& errorMessage)
{
BOOST_ASSERT(device);
uint16_t deviceUid = device->m_Uid;
const std::string& deviceName = device->m_Name;
uint16_t deviceCores = device->m_Cores;
BOOST_ASSERT(!deviceName.empty());
// Device record word 0:
// 16:31 [16] uid: the unique identifier for the device
// 0:15 [16] cores: the number of individual streams of counters for one or more cores of some device
uint32_t deviceRecordWord0 = (static_cast<uint32_t>(deviceUid) << 16) |
(static_cast<uint32_t>(deviceCores));
// Device record word 1:
// 0:31 [32] name_offset: offset from the beginning of the device record pool to the name field
uint32_t deviceRecordWord1 = 0; // The offset is always zero here, as the name field is always
// the first (and only) item in the pool
// Convert the device name into a SWTrace string
std::vector<uint32_t> deviceNameBuffer;
if (!StringToSwTraceString<SwTraceCharPolicy>(deviceName, deviceNameBuffer))
{
errorMessage = boost::str(boost::format("Cannot convert the name of device %1% (\"%2%\") to an SWTrace string")
% deviceUid
% deviceName);
return false;
}
// Calculate the size in words of the device record
size_t deviceRecordSize = 2u + // The size of the fixed part (uid + cores + name_offset)
deviceNameBuffer.size(); // The size of the variable part (the device name including
// the null-terminator)
// Allocate the necessary space for the device record
deviceRecord.resize(deviceRecordSize);
// Create the device record
deviceRecord[0] = deviceRecordWord0; // uid + core
deviceRecord[1] = deviceRecordWord1; // name_offset
auto offset = deviceRecord.begin() + 2u;
std::copy(deviceNameBuffer.begin(), deviceNameBuffer.end(), offset); // name
return true;
}
bool SendCounterPacket::CreateCounterSetRecord(const CounterSetPtr& counterSet,
CounterSetRecord& counterSetRecord,
std::string& errorMessage)
{
BOOST_ASSERT(counterSet);
uint16_t counterSetUid = counterSet->m_Uid;
const std::string& counterSetName = counterSet->m_Name;
uint16_t counterSetCount = counterSet->m_Count;
BOOST_ASSERT(!counterSetName.empty());
// Counter set record word 0:
// 16:31 [16] uid: the unique identifier for the counter_set
// 0:15 [16] count: the number of counters which can be active in this set at any one time
uint32_t counterSetRecordWord0 = (static_cast<uint32_t>(counterSetUid) << 16) |
(static_cast<uint32_t>(counterSetCount));
// Counter set record word 1:
// 0:31 [32] name_offset: offset from the beginning of the counter set pool to the name field
uint32_t counterSetRecordWord1 = 0; // The offset is always zero here, as the name field is always
// the first (and only) item in the pool
// Convert the device name into a SWTrace namestring
std::vector<uint32_t> counterSetNameBuffer;
if (!StringToSwTraceString<SwTraceNameCharPolicy>(counterSet->m_Name, counterSetNameBuffer))
{
errorMessage = boost::str(boost::format("Cannot convert the name of counter set %1% (\"%2%\") to "
"an SWTrace namestring")
% counterSetUid
% counterSetName);
return false;
}
// Calculate the size in words of the counter set record
size_t counterSetRecordSize = 2u + // The size of the fixed part (uid + cores + name_offset)
counterSetNameBuffer.size(); // The size of the variable part (the counter set name
// including the null-terminator)
// Allocate the space for the counter set record
counterSetRecord.resize(counterSetRecordSize);
// Create the counter set record
counterSetRecord[0] = counterSetRecordWord0; // uid + core
counterSetRecord[1] = counterSetRecordWord1; // name_offset
auto offset = counterSetRecord.begin() + 2u;
std::copy(counterSetNameBuffer.begin(), counterSetNameBuffer.end(), offset); // name
return true;
}
bool SendCounterPacket::CreateEventRecord(const CounterPtr& counter,
EventRecord& eventRecord,
std::string& errorMessage)
{
using namespace boost::numeric;
BOOST_ASSERT(counter);
uint16_t counterUid = counter->m_Uid;
uint16_t maxCounterUid = counter->m_MaxCounterUid;
uint16_t deviceUid = counter->m_DeviceUid;
uint16_t counterSetUid = counter->m_CounterSetUid;
uint16_t counterClass = counter->m_Class;
uint16_t counterInterpolation = counter->m_Interpolation;
double counterMultiplier = counter->m_Multiplier;
const std::string& counterName = counter->m_Name;
const std::string& counterDescription = counter->m_Description;
const std::string& counterUnits = counter->m_Units;
BOOST_ASSERT(counterClass == 0 || counterClass == 1);
BOOST_ASSERT(counterInterpolation == 0 || counterInterpolation == 1);
BOOST_ASSERT(counterMultiplier);
// Utils
size_t uint32_t_size = sizeof(uint32_t);
// Event record word 0:
// 16:31 [16] max_counter_uid: if the device this event is associated with has more than one core and there
// is one of these counters per core this value will be set to
// (counter_uid + cores (from device_record)) - 1.
// If there is only a single core then this value will be the same as
// the counter_uid value
// 0:15 [16] count_uid: unique ID for the counter. Must be unique across all counters in all categories
uint32_t eventRecordWord0 = (static_cast<uint32_t>(maxCounterUid) << 16) |
(static_cast<uint32_t>(counterUid));
// Event record word 1:
// 16:31 [16] device: UID of the device this event is associated with. Set to zero if the event is NOT
// associated with a device
// 0:15 [16] counter_set: UID of the counter_set this event is associated with. Set to zero if the event
// is NOT associated with a counter_set
uint32_t eventRecordWord1 = (static_cast<uint32_t>(deviceUid) << 16) |
(static_cast<uint32_t>(counterSetUid));
// Event record word 2:
// 16:31 [16] class: type describing how to treat each data point in a stream of data points
// 0:15 [16] interpolation: type describing how to interpolate each data point in a stream of data points
uint32_t eventRecordWord2 = (static_cast<uint32_t>(counterClass) << 16) |
(static_cast<uint32_t>(counterInterpolation));
// Event record word 3-4:
// 0:63 [64] multiplier: internal data stream is represented as integer values, this allows scaling of
// those values as if they are fixed point numbers. Zero is not a valid value
uint32_t multiplier[2] = { 0u, 0u };
BOOST_ASSERT(sizeof(counterMultiplier) == sizeof(multiplier));
std::memcpy(multiplier, &counterMultiplier, sizeof(multiplier));
uint32_t eventRecordWord3 = multiplier[0];
uint32_t eventRecordWord4 = multiplier[1];
// Event record word 5:
// 0:31 [32] name_offset: offset from the beginning of the event record pool to the name field
uint32_t eventRecordWord5 = 0; // The offset is always zero here, as the name field is always
// the first item in the pool
// Convert the counter name into a SWTrace string
std::vector<uint32_t> counterNameBuffer;
if (!StringToSwTraceString<SwTraceCharPolicy>(counterName, counterNameBuffer))
{
errorMessage = boost::str(boost::format("Cannot convert the name of counter %1% (name: \"%2%\") "
"to an SWTrace string")
% counterUid
% counterName);
return false;
}
// Event record word 6:
// 0:31 [32] description_offset: offset from the beginning of the event record pool to the description field
// The size of the name buffer in bytes
uint32_t eventRecordWord6 = numeric_cast<uint32_t>(counterNameBuffer.size() * uint32_t_size);
// Convert the counter description into a SWTrace string
std::vector<uint32_t> counterDescriptionBuffer;
if (!StringToSwTraceString<SwTraceCharPolicy>(counterDescription, counterDescriptionBuffer))
{
errorMessage = boost::str(boost::format("Cannot convert the description of counter %1% (description: \"%2%\") "
"to an SWTrace string")
% counterUid
% counterName);
return false;
}
// Event record word 7:
// 0:31 [32] units_offset: (optional) offset from the beginning of the event record pool to the units field.
// An offset value of zero indicates this field is not provided
bool includeUnits = !counterUnits.empty();
// The size of the description buffer in bytes
uint32_t eventRecordWord7 = includeUnits ?
eventRecordWord6 +
numeric_cast<uint32_t>(counterDescriptionBuffer.size() * uint32_t_size) :
0;
// Convert the counter units into a SWTrace namestring (optional)
std::vector<uint32_t> counterUnitsBuffer;
if (includeUnits)
{
// Convert the counter units into a SWTrace namestring
if (!StringToSwTraceString<SwTraceNameCharPolicy>(counterUnits, counterUnitsBuffer))
{
errorMessage = boost::str(boost::format("Cannot convert the units of counter %1% (units: \"%2%\") "
"to an SWTrace string")
% counterUid
% counterName);
return false;
}
}
// Calculate the size in words of the event record
size_t eventRecordSize = 8u + // The size of the fixed part (counter_uid + max_counter_uid + device +
// counter_set + class + interpolation +
// multiplier + name_offset + description_offset +
// units_offset)
counterNameBuffer.size() + // The size of the variable part (the counter name,
counterDescriptionBuffer.size() + // description and units including the null-terminator)
counterUnitsBuffer.size();
// Allocate the space for the event record
eventRecord.resize(eventRecordSize);
ARMNN_NO_CONVERSION_WARN_BEGIN
// Create the event record
eventRecord[0] = eventRecordWord0; // max_counter_uid + counter_uid
eventRecord[1] = eventRecordWord1; // device + counter_set
eventRecord[2] = eventRecordWord2; // class + interpolation
eventRecord[3] = eventRecordWord3; // multiplier
eventRecord[4] = eventRecordWord4; // multiplier
eventRecord[5] = eventRecordWord5; // name_offset
eventRecord[6] = eventRecordWord6; // description_offset
eventRecord[7] = eventRecordWord7; // units_offset
auto offset = eventRecord.begin() + 8u;
std::copy(counterNameBuffer.begin(), counterNameBuffer.end(), offset); // name
offset += counterNameBuffer.size();
std::copy(counterDescriptionBuffer.begin(), counterDescriptionBuffer.end(), offset); // description
if (includeUnits)
{
offset += counterDescriptionBuffer.size();
std::copy(counterUnitsBuffer.begin(), counterUnitsBuffer.end(), offset); // units
}
ARMNN_NO_CONVERSION_WARN_END
return true;
}
void SendCounterPacket::SendCounterDirectoryPacket(const ICounterDirectory& counterDirectory)
{
using namespace boost::numeric;
// Get the amount of data that needs to be put into the packet
uint16_t categoryCount = counterDirectory.GetCategoryCount();
uint16_t deviceCount = counterDirectory.GetDeviceCount();
uint16_t counterSetCount = counterDirectory.GetCounterSetCount();
// Utils
size_t uint32_t_size = sizeof(uint32_t);
size_t packetHeaderSize = 2u;
size_t bodyHeaderSize = 6u;
// Initialize the offset for the pointer tables
uint32_t pointerTableOffset = 0;
// --------------
// Device records
// --------------
// Process device records
std::vector<DeviceRecord> deviceRecords(deviceCount);
const Devices& devices = counterDirectory.GetDevices();
std::vector<uint32_t> deviceRecordOffsets(deviceCount, 0); // device_records_pointer_table
size_t deviceRecordsSize = 0;
size_t deviceIndex = 0;
size_t deviceRecordOffsetIndex = 0;
for (auto it = devices.begin(); it != devices.end(); it++)
{
const DevicePtr& device = it->second;
DeviceRecord& deviceRecord = deviceRecords.at(deviceIndex);
std::string errorMessage;
if (!CreateDeviceRecord(device, deviceRecord, errorMessage))
{
CancelOperationAndThrow<RuntimeException>(errorMessage);
}
// Update the total size in words of the device records
deviceRecordsSize += deviceRecord.size();
// Add the device record offset to the device records pointer table offset field
deviceRecordOffsets[deviceRecordOffsetIndex] = pointerTableOffset;
pointerTableOffset += numeric_cast<uint32_t>(deviceRecord.size() * uint32_t_size);
deviceIndex++;
deviceRecordOffsetIndex++;
}
// -------------------
// Counter set records
// -------------------
// Process counter set records
std::vector<CounterSetRecord> counterSetRecords(counterSetCount);
const CounterSets& counterSets = counterDirectory.GetCounterSets();
std::vector<uint32_t> counterSetRecordOffsets(counterSetCount, 0); // counter_set_records_pointer_table
size_t counterSetRecordsSize = 0;
size_t counterSetIndex = 0;
size_t counterSetRecordOffsetIndex = 0;
for (auto it = counterSets.begin(); it != counterSets.end(); it++)
{
const CounterSetPtr& counterSet = it->second;
CounterSetRecord& counterSetRecord = counterSetRecords.at(counterSetIndex);
std::string errorMessage;
if (!CreateCounterSetRecord(counterSet, counterSetRecord, errorMessage))
{
CancelOperationAndThrow<RuntimeException>(errorMessage);
}
// Update the total size in words of the counter set records
counterSetRecordsSize += counterSetRecord.size();
// Add the counter set record offset to the counter set records pointer table offset field
counterSetRecordOffsets[counterSetRecordOffsetIndex] = pointerTableOffset;
pointerTableOffset += numeric_cast<uint32_t>(counterSetRecord.size() * uint32_t_size);
counterSetIndex++;
counterSetRecordOffsetIndex++;
}
// ----------------
// Category records
// ----------------
// Process category records
std::vector<CategoryRecord> categoryRecords(categoryCount);
const Categories& categories = counterDirectory.GetCategories();
std::vector<uint32_t> categoryRecordOffsets(categoryCount, 0); // category_records_pointer_table
size_t categoryRecordsSize = 0;
size_t categoryIndex = 0;
size_t categoryRecordOffsetIndex = 0;
for (auto it = categories.begin(); it != categories.end(); it++)
{
const CategoryPtr& category = *it;
CategoryRecord& categoryRecord = categoryRecords.at(categoryIndex);
std::string errorMessage;
if (!CreateCategoryRecord(category, counterDirectory.GetCounters(), categoryRecord, errorMessage))
{
CancelOperationAndThrow<RuntimeException>(errorMessage);
}
// Update the total size in words of the category records
categoryRecordsSize += categoryRecord.size();
// Add the category record offset to the category records pointer table offset field
categoryRecordOffsets[categoryRecordOffsetIndex] = pointerTableOffset;
pointerTableOffset += numeric_cast<uint32_t>(categoryRecord.size() * uint32_t_size);
categoryIndex++;
categoryRecordOffsetIndex++;
}
// Calculate the length in words of the counter directory packet's data (excludes the packet header size)
size_t counterDirectoryPacketDataLength =
bodyHeaderSize + // The size of the body header
deviceRecordOffsets.size() + // The size of the device records pointer table
counterSetRecordOffsets.size() + // The size of counter set pointer table
categoryRecordOffsets.size() + // The size of category records pointer table
deviceRecordsSize + // The total size of the device records
counterSetRecordsSize + // The total size of the counter set records
categoryRecordsSize; // The total size of the category records
// Calculate the size in words of the counter directory packet (the data length plus the packet header size)
size_t counterDirectoryPacketSize = packetHeaderSize + // The size of the packet header
counterDirectoryPacketDataLength; // The data length
// Allocate the necessary space for the counter directory packet
std::vector<uint32_t> counterDirectoryPacket(counterDirectoryPacketSize, 0);
// -------------
// Packet header
// -------------
// Packet header word 0:
// 26:31 [6] packet_family: control Packet Family
// 16:25 [10] packet_id: packet identifier
// 8:15 [8] reserved: all zeros
// 0:7 [8] reserved: all zeros
uint32_t packetFamily = 0;
uint32_t packetId = 2;
uint32_t packetHeaderWord0 = ((packetFamily & 0x3F) << 26) | ((packetId & 0x3FF) << 16);
// Packet header word 1:
// 0:31 [32] data_length: length of data, in bytes
uint32_t packetHeaderWord1 = numeric_cast<uint32_t>(counterDirectoryPacketDataLength * uint32_t_size);
// Create the packet header
uint32_t packetHeader[2]
{
packetHeaderWord0, // packet_family + packet_id + reserved + reserved
packetHeaderWord1 // data_length
};
// -----------
// Body header
// -----------
// Body header word 0:
// 16:31 [16] device_records_count: number of entries in the device_records_pointer_table
// 0:15 [16] reserved: all zeros
uint32_t bodyHeaderWord0 = static_cast<uint32_t>(deviceCount) << 16;
// Body header word 1:
// 0:31 [32] device_records_pointer_table_offset: offset to the device_records_pointer_table
uint32_t bodyHeaderWord1 = 0; // The offset is always zero here, as the device record pointer table field is always
// the first item in the pool
// Body header word 2:
// 16:31 [16] counter_set_count: number of entries in the counter_set_pointer_table
// 0:15 [16] reserved: all zeros
uint32_t bodyHeaderWord2 = static_cast<uint32_t>(counterSetCount) << 16;
// Body header word 3:
// 0:31 [32] counter_set_pointer_table_offset: offset to the counter_set_pointer_table
uint32_t bodyHeaderWord3 =
numeric_cast<uint32_t>(deviceRecordOffsets.size() * uint32_t_size); // The size of the device records
// pointer table
// Body header word 4:
// 16:31 [16] categories_count: number of entries in the categories_pointer_table
// 0:15 [16] reserved: all zeros
uint32_t bodyHeaderWord4 = static_cast<uint32_t>(categoryCount) << 16;
// Body header word 3:
// 0:31 [32] categories_pointer_table_offset: offset to the categories_pointer_table
uint32_t bodyHeaderWord5 =
numeric_cast<uint32_t>(deviceRecordOffsets.size() * uint32_t_size + // The size of the device records
counterSetRecordOffsets.size() * uint32_t_size); // pointer table, plus the size of
// the counter set pointer table
// Create the body header
uint32_t bodyHeader[6]
{
bodyHeaderWord0, // device_records_count + reserved
bodyHeaderWord1, // device_records_pointer_table_offset
bodyHeaderWord2, // counter_set_count + reserved
bodyHeaderWord3, // counter_set_pointer_table_offset
bodyHeaderWord4, // categories_count + reserved
bodyHeaderWord5 // categories_pointer_table_offset
};
ARMNN_NO_CONVERSION_WARN_BEGIN
// Create the counter directory packet
auto counterDirectoryPacketOffset = counterDirectoryPacket.begin();
// packet_header
std::copy(packetHeader, packetHeader + packetHeaderSize, counterDirectoryPacketOffset);
counterDirectoryPacketOffset += packetHeaderSize;
// body_header
std::copy(bodyHeader, bodyHeader + bodyHeaderSize, counterDirectoryPacketOffset);
counterDirectoryPacketOffset += bodyHeaderSize;
// device_records_pointer_table
std::copy(deviceRecordOffsets.begin(), deviceRecordOffsets.end(), counterDirectoryPacketOffset);
counterDirectoryPacketOffset += deviceRecordOffsets.size();
// counter_set_pointer_table
std::copy(counterSetRecordOffsets.begin(), counterSetRecordOffsets.end(), counterDirectoryPacketOffset);
counterDirectoryPacketOffset += counterSetRecordOffsets.size();
// category_pointer_table
std::copy(categoryRecordOffsets.begin(), categoryRecordOffsets.end(), counterDirectoryPacketOffset);
counterDirectoryPacketOffset += categoryRecordOffsets.size();
// device_records
for (const DeviceRecord& deviceRecord : deviceRecords)
{
std::copy(deviceRecord.begin(), deviceRecord.end(), counterDirectoryPacketOffset); // device_record
counterDirectoryPacketOffset += deviceRecord.size();
}
// counter_set_records
for (const CounterSetRecord& counterSetRecord : counterSetRecords)
{
std::copy(counterSetRecord.begin(), counterSetRecord.end(), counterDirectoryPacketOffset); // counter_set_record
counterDirectoryPacketOffset += counterSetRecord.size();
}
// category_records
for (const CategoryRecord& categoryRecord : categoryRecords)
{
std::copy(categoryRecord.begin(), categoryRecord.end(), counterDirectoryPacketOffset); // category_record
counterDirectoryPacketOffset += categoryRecord.size();
}
ARMNN_NO_CONVERSION_WARN_END
// Calculate the total size in bytes of the counter directory packet
uint32_t totalSize = numeric_cast<uint32_t>(counterDirectoryPacketSize * uint32_t_size);
// Reserve space in the buffer for the packet
uint32_t reserved = 0;
std::unique_ptr<IPacketBuffer> writeBuffer = m_BufferManager.Reserve(totalSize, reserved);
if (writeBuffer == nullptr || reserved < totalSize)
{
CancelOperationAndThrow<BufferExhaustion>(
writeBuffer,
boost::str(boost::format("No space left in buffer. Unable to reserve (%1%) bytes.") % totalSize));
}
// Offset for writing to the buffer
uint32_t offset = 0;
// Write the counter directory packet to the buffer
for (uint32_t counterDirectoryPacketWord : counterDirectoryPacket)
{
WriteUint32(writeBuffer, offset, counterDirectoryPacketWord);
offset += numeric_cast<uint32_t>(uint32_t_size);
}
m_BufferManager.Commit(writeBuffer, totalSize);
}
void SendCounterPacket::SendPeriodicCounterCapturePacket(uint64_t timestamp, const IndexValuePairsVector& values)
{
uint32_t uint16_t_size = sizeof(uint16_t);
uint32_t uint32_t_size = sizeof(uint32_t);
uint32_t uint64_t_size = sizeof(uint64_t);
uint32_t packetFamily = 1;
uint32_t packetClass = 0;
uint32_t packetType = 0;
uint32_t headerSize = 2 * uint32_t_size;
uint32_t bodySize = uint64_t_size + numeric_cast<uint32_t>(values.size()) * (uint16_t_size + uint32_t_size);
uint32_t totalSize = headerSize + bodySize;
uint32_t offset = 0;
uint32_t reserved = 0;
std::unique_ptr<IPacketBuffer> writeBuffer = m_BufferManager.Reserve(totalSize, reserved);
if (writeBuffer == nullptr || reserved < totalSize)
{
CancelOperationAndThrow<BufferExhaustion>(
writeBuffer,
boost::str(boost::format("No space left in buffer. Unable to reserve (%1%) bytes.") % totalSize));
}
// Create header.
WriteUint32(writeBuffer,
offset,
((packetFamily & 0x0000003F) << 26) |
((packetClass & 0x0000007F) << 19) |
((packetType & 0x00000007) << 16));
offset += uint32_t_size;
WriteUint32(writeBuffer, offset, bodySize);
// Copy captured Timestamp.
offset += uint32_t_size;
WriteUint64(writeBuffer, offset, timestamp);
// Copy selectedCounterIds.
offset += uint64_t_size;
for (const auto& pair: values)
{
WriteUint16(writeBuffer, offset, pair.first);
offset += uint16_t_size;
WriteUint32(writeBuffer, offset, pair.second);
offset += uint32_t_size;
}
m_BufferManager.Commit(writeBuffer, totalSize);
}
void SendCounterPacket::SendPeriodicCounterSelectionPacket(uint32_t capturePeriod,
const std::vector<uint16_t>& selectedCounterIds)
{
uint32_t uint16_t_size = sizeof(uint16_t);
uint32_t uint32_t_size = sizeof(uint32_t);
uint32_t packetFamily = 0;
uint32_t packetId = 4;
uint32_t headerSize = 2 * uint32_t_size;
uint32_t bodySize = uint32_t_size + numeric_cast<uint32_t>(selectedCounterIds.size()) * uint16_t_size;
uint32_t totalSize = headerSize + bodySize;
uint32_t offset = 0;
uint32_t reserved = 0;
std::unique_ptr<IPacketBuffer> writeBuffer = m_BufferManager.Reserve(totalSize, reserved);
if (writeBuffer == nullptr || reserved < totalSize)
{
CancelOperationAndThrow<BufferExhaustion>(
writeBuffer,
boost::str(boost::format("No space left in buffer. Unable to reserve (%1%) bytes.") % totalSize));
}
// Create header.
WriteUint32(writeBuffer, offset, ((packetFamily & 0x3F) << 26) | ((packetId & 0x3FF) << 16));
offset += uint32_t_size;
WriteUint32(writeBuffer, offset, bodySize);
// Copy capturePeriod.
offset += uint32_t_size;
WriteUint32(writeBuffer, offset, capturePeriod);
// Copy selectedCounterIds.
offset += uint32_t_size;
for(const uint16_t& id: selectedCounterIds)
{
WriteUint16(writeBuffer, offset, id);
offset += uint16_t_size;
}
m_BufferManager.Commit(writeBuffer, totalSize);
}
void SendCounterPacket::SetReadyToRead()
{
// Signal the send thread that there's something to read in the buffer
m_WaitCondition.notify_one();
}
void SendCounterPacket::Start(IProfilingConnection& profilingConnection)
{
// Check if the send thread is already running
if (m_IsRunning.load())
{
// The send thread is already running
return;
}
// Mark the send thread as running
m_IsRunning.store(true);
// Keep the send procedure going until the send thread is signalled to stop
m_KeepRunning.store(true);
// Start the send thread
m_SendThread = std::thread(&SendCounterPacket::Send, this, std::ref(profilingConnection));
}
void SendCounterPacket::Stop(bool rethrowSendThreadExceptions)
{
// Signal the send thread to stop
m_KeepRunning.store(false);
// Check that the send thread is running
if (m_SendThread.joinable())
{
// Kick the send thread out of the wait condition
m_WaitCondition.notify_one();
// Wait for the send thread to complete operations
m_SendThread.join();
}
// Check if the send thread exception has to be rethrown
if (!rethrowSendThreadExceptions)
{
// No need to rethrow the send thread exception, return immediately
return;
}
// Exception handling lock scope - Begin
{
// Lock the mutex to handle any exception coming from the send thread
std::lock_guard<std::mutex> lock(m_WaitMutex);
// Check if there's an exception to rethrow
if (m_SendThreadException)
{
// Rethrow the send thread exception
std::rethrow_exception(m_SendThreadException);
// Nullify the exception as it has been rethrown
m_SendThreadException = nullptr;
}
}
// Exception handling lock scope - End
}
void SendCounterPacket::Send(IProfilingConnection& profilingConnection)
{
// Keep the sending procedure looping until the thread is signalled to stop
while (m_KeepRunning.load())
{
// Wait condition lock scope - Begin
{
// Lock the mutex to wait on it
std::unique_lock<std::mutex> lock(m_WaitMutex);
// Check the current state of the profiling service
ProfilingState currentState = m_StateMachine.GetCurrentState();
switch (currentState)
{
case ProfilingState::Uninitialised:
case ProfilingState::NotConnected:
// The send thread cannot be running when the profiling service is uninitialized or not connected,
// stop the thread immediately
m_KeepRunning.store(false);
m_IsRunning.store(false);
// An exception should be thrown here, save it to be rethrown later from the main thread so that
// it can be caught by the consumer
m_SendThreadException =
std::make_exception_ptr(RuntimeException("The send thread should not be running with the "
"profiling service not yet initialized or connected"));
return;
case ProfilingState::WaitingForAck:
// Send out a StreamMetadata packet and wait for the profiling connection to be acknowledged.
// When a ConnectionAcknowledged packet is received, the profiling service state will be automatically
// updated by the command handler
// Prepare a StreamMetadata packet and write it to the Counter Stream buffer
SendStreamMetaDataPacket();
// Flush the buffer manually to send the packet
FlushBuffer(profilingConnection);
// Wait indefinitely until notified otherwise (it could that the profiling state has changed due to the
// connection being acknowledged, or that new data is ready to be sent, or that the send thread is
// being shut down, etc.)
m_WaitCondition.wait(lock);
// Do not flush the buffer again
continue;
case ProfilingState::Active:
default:
// Normal working state for the send thread
// Check if the send thread is required to enforce a timeout wait policy
if (m_Timeout < 0)
{
// Wait indefinitely until notified that something to read has become available in the buffer
m_WaitCondition.wait(lock);
}
else
{
// Wait until the thread is notified of something to read from the buffer,
// or check anyway after the specified number of milliseconds
m_WaitCondition.wait_for(lock, std::chrono::milliseconds(m_Timeout));
}
break;
}
}
// Wait condition lock scope - End
// Send all the available packets in the buffer
FlushBuffer(profilingConnection);
}
// Ensure that all readable data got written to the profiling connection before the thread is stopped
// (do not notify any watcher in this case, as this is just to wrap up things before shutting down the send thread)
FlushBuffer(profilingConnection, false);
// Mark the send thread as not running
m_IsRunning.store(false);
}
void SendCounterPacket::FlushBuffer(IProfilingConnection& profilingConnection, bool notifyWatchers)
{
// Get the first available readable buffer
std::unique_ptr<IPacketBuffer> packetBuffer = m_BufferManager.GetReadableBuffer();
// Initialize the flag that indicates whether at least a packet has been sent
bool packetsSent = false;
while (packetBuffer != nullptr)
{
// Get the data to send from the buffer
const unsigned char* readBuffer = packetBuffer->GetReadableData();
unsigned int readBufferSize = packetBuffer->GetSize();
if (readBuffer == nullptr || readBufferSize == 0)
{
// Nothing to send, get the next available readable buffer and continue
m_BufferManager.MarkRead(packetBuffer);
packetBuffer = m_BufferManager.GetReadableBuffer();
continue;
}
// Check that the profiling connection is open, silently drop the data and continue if it's closed
if (profilingConnection.IsOpen())
{
// Write a packet to the profiling connection. Silently ignore any write error and continue
profilingConnection.WritePacket(readBuffer, boost::numeric_cast<uint32_t>(readBufferSize));
// Set the flag that indicates whether at least a packet has been sent
packetsSent = true;
}
// Mark the packet buffer as read
m_BufferManager.MarkRead(packetBuffer);
// Get the next available readable buffer
packetBuffer = m_BufferManager.GetReadableBuffer();
}
// Check whether at least a packet has been sent
if (packetsSent && notifyWatchers)
{
// Notify to any watcher that something has been sent
m_PacketSentWaitCondition.notify_one();
}
}
} // namespace profiling
} // namespace armnn