From 3e9bc19ad523361e6b18057849e30c0c48183915 Mon Sep 17 00:00:00 2001 From: Jim Flynn Date: Wed, 23 Mar 2022 23:01:26 +0000 Subject: IVGCVSW-6706 Create the libpipeClient library Change-Id: I2368aade38ad3808fab55d8a86cd659d4e95d91e Signed-off-by: Jim Flynn --- src/profiling/ProfilingUtils.cpp | 647 --------------------------------------- 1 file changed, 647 deletions(-) delete mode 100644 src/profiling/ProfilingUtils.cpp (limited to 'src/profiling/ProfilingUtils.cpp') diff --git a/src/profiling/ProfilingUtils.cpp b/src/profiling/ProfilingUtils.cpp deleted file mode 100644 index 2963a98621..0000000000 --- a/src/profiling/ProfilingUtils.cpp +++ /dev/null @@ -1,647 +0,0 @@ -// -// Copyright © 2019 Arm Ltd and Contributors. All rights reserved. -// SPDX-License-Identifier: MIT -// - -#include "ProfilingUtils.hpp" - -#include -#include -#include -#include -#include - -#include - -#include -#include -#include - -namespace arm -{ - -namespace pipe -{ - -void WriteBytes(const IPacketBufferPtr& packetBuffer, unsigned int offset, const void* value, unsigned int valueSize) -{ - ARM_PIPE_ASSERT(packetBuffer); - - WriteBytes(packetBuffer->GetWritableData(), offset, value, valueSize); -} - -uint32_t ConstructHeader(uint32_t packetFamily, - uint32_t packetId) -{ - return (( packetFamily & 0x0000003F ) << 26 )| - (( packetId & 0x000003FF ) << 16 ); -} - -uint32_t ConstructHeader(uint32_t packetFamily, uint32_t packetClass, uint32_t packetType) -{ - return ((packetFamily & 0x0000003F) << 26) | - ((packetClass & 0x0000007F) << 19) | - ((packetType & 0x00000007) << 16); -} - -void WriteUint64(const std::unique_ptr& packetBuffer, unsigned int offset, uint64_t value) -{ - ARM_PIPE_ASSERT(packetBuffer); - - WriteUint64(packetBuffer->GetWritableData(), offset, value); -} - -void WriteUint32(const IPacketBufferPtr& packetBuffer, unsigned int offset, uint32_t value) -{ - ARM_PIPE_ASSERT(packetBuffer); - - WriteUint32(packetBuffer->GetWritableData(), offset, value); -} - -void WriteUint16(const IPacketBufferPtr& packetBuffer, unsigned int offset, uint16_t value) -{ - ARM_PIPE_ASSERT(packetBuffer); - - WriteUint16(packetBuffer->GetWritableData(), offset, value); -} - -void WriteUint8(const IPacketBufferPtr& packetBuffer, unsigned int offset, uint8_t value) -{ - ARM_PIPE_ASSERT(packetBuffer); - - WriteUint8(packetBuffer->GetWritableData(), offset, value); -} - -void ReadBytes(const IPacketBufferPtr& packetBuffer, unsigned int offset, unsigned int valueSize, uint8_t outValue[]) -{ - ARM_PIPE_ASSERT(packetBuffer); - - ReadBytes(packetBuffer->GetReadableData(), offset, valueSize, outValue); -} - -uint64_t ReadUint64(const IPacketBufferPtr& packetBuffer, unsigned int offset) -{ - ARM_PIPE_ASSERT(packetBuffer); - - return ReadUint64(packetBuffer->GetReadableData(), offset); -} - -uint32_t ReadUint32(const IPacketBufferPtr& packetBuffer, unsigned int offset) -{ - ARM_PIPE_ASSERT(packetBuffer); - - return ReadUint32(packetBuffer->GetReadableData(), offset); -} - -uint16_t ReadUint16(const IPacketBufferPtr& packetBuffer, unsigned int offset) -{ - ARM_PIPE_ASSERT(packetBuffer); - - return ReadUint16(packetBuffer->GetReadableData(), offset); -} - -uint8_t ReadUint8(const IPacketBufferPtr& packetBuffer, unsigned int offset) -{ - ARM_PIPE_ASSERT(packetBuffer); - - return ReadUint8(packetBuffer->GetReadableData(), offset); -} - -std::string GetProcessName() -{ - std::ifstream comm("/proc/self/comm"); - std::string name; - getline(comm, name); - return name; -} - -/// Creates a timeline packet header -/// -/// \params -/// packetFamiliy Timeline Packet Family -/// packetClass Timeline Packet Class -/// packetType Timeline Packet Type -/// streamId Stream identifier -/// seqeunceNumbered When non-zero the 4 bytes following the header is a u32 sequence number -/// dataLength Unsigned 24-bit integer. Length of data, in bytes. Zero is permitted -/// -/// \returns -/// Pair of uint32_t containing word0 and word1 of the header -std::pair CreateTimelinePacketHeader(uint32_t packetFamily, - uint32_t packetClass, - uint32_t packetType, - uint32_t streamId, - uint32_t sequenceNumbered, - uint32_t dataLength) -{ - // Packet header word 0: - // 26:31 [6] packet_family: timeline Packet Family, value 0b000001 - // 19:25 [7] packet_class: packet class - // 16:18 [3] packet_type: packet type - // 8:15 [8] reserved: all zeros - // 0:7 [8] stream_id: stream identifier - uint32_t packetHeaderWord0 = ((packetFamily & 0x0000003F) << 26) | - ((packetClass & 0x0000007F) << 19) | - ((packetType & 0x00000007) << 16) | - ((streamId & 0x00000007) << 0); - - // Packet header word 1: - // 25:31 [7] reserved: all zeros - // 24 [1] sequence_numbered: when non-zero the 4 bytes following the header is a u32 sequence number - // 0:23 [24] data_length: unsigned 24-bit integer. Length of data, in bytes. Zero is permitted - uint32_t packetHeaderWord1 = ((sequenceNumbered & 0x00000001) << 24) | - ((dataLength & 0x00FFFFFF) << 0); - - return std::make_pair(packetHeaderWord0, packetHeaderWord1); -} - -/// Creates a packet header for the timeline messages: -/// * declareLabel -/// * declareEntity -/// * declareEventClass -/// * declareRelationship -/// * declareEvent -/// -/// \param -/// dataLength The length of the message body in bytes -/// -/// \returns -/// Pair of uint32_t containing word0 and word1 of the header -std::pair CreateTimelineMessagePacketHeader(unsigned int dataLength) -{ - return CreateTimelinePacketHeader(1, // Packet family - 0, // Packet class - 1, // Packet type - 0, // Stream id - 0, // Sequence number - dataLength); // Data length -} - -TimelinePacketStatus WriteTimelineLabelBinaryPacket(uint64_t profilingGuid, - const std::string& label, - unsigned char* buffer, - unsigned int remainingBufferSize, - unsigned int& numberOfBytesWritten) -{ - // Initialize the output value - numberOfBytesWritten = 0; - - // Check that the given buffer is valid - if (buffer == nullptr || remainingBufferSize == 0) - { - return TimelinePacketStatus::BufferExhaustion; - } - - // Utils - unsigned int uint32_t_size = sizeof(uint32_t); - unsigned int uint64_t_size = sizeof(uint64_t); - - // Convert the label into a SWTrace string - std::vector swTraceLabel; - bool result = arm::pipe::StringToSwTraceString(label, swTraceLabel); - if (!result) - { - return TimelinePacketStatus::Error; - } - - // Calculate the size of the SWTrace string label (in bytes) - unsigned int swTraceLabelSize = arm::pipe::numeric_cast(swTraceLabel.size()) * uint32_t_size; - - // Calculate the length of the data (in bytes) - unsigned int timelineLabelPacketDataLength = uint32_t_size + // decl_Id - uint64_t_size + // Profiling GUID - swTraceLabelSize; // Label - - // Check whether the timeline binary packet fits in the given buffer - if (timelineLabelPacketDataLength > remainingBufferSize) - { - return TimelinePacketStatus::BufferExhaustion; - } - - // Initialize the offset for writing in the buffer - unsigned int offset = 0; - - // Write decl_Id to the buffer - WriteUint32(buffer, offset, 0u); - offset += uint32_t_size; - - // Write the timeline binary packet payload to the buffer - WriteUint64(buffer, offset, profilingGuid); // Profiling GUID - offset += uint64_t_size; - for (uint32_t swTraceLabelWord : swTraceLabel) - { - WriteUint32(buffer, offset, swTraceLabelWord); // Label - offset += uint32_t_size; - } - - // Update the number of bytes written - numberOfBytesWritten = timelineLabelPacketDataLength; - - return TimelinePacketStatus::Ok; -} - -TimelinePacketStatus WriteTimelineEntityBinary(uint64_t profilingGuid, - unsigned char* buffer, - unsigned int remainingBufferSize, - unsigned int& numberOfBytesWritten) -{ - // Initialize the output value - numberOfBytesWritten = 0; - - // Check that the given buffer is valid - if (buffer == nullptr || remainingBufferSize == 0) - { - return TimelinePacketStatus::BufferExhaustion; - } - - // Utils - unsigned int uint32_t_size = sizeof(uint32_t); - unsigned int uint64_t_size = sizeof(uint64_t); - - // Calculate the length of the data (in bytes) - unsigned int timelineEntityDataLength = uint32_t_size + uint64_t_size; // decl_id + Profiling GUID - - // Check whether the timeline binary packet fits in the given buffer - if (timelineEntityDataLength > remainingBufferSize) - { - return TimelinePacketStatus::BufferExhaustion; - } - - // Initialize the offset for writing in the buffer - unsigned int offset = 0; - - // Write the decl_Id to the buffer - WriteUint32(buffer, offset, 1u); - offset += uint32_t_size; - - // Write the timeline binary packet payload to the buffer - WriteUint64(buffer, offset, profilingGuid); // Profiling GUID - - // Update the number of bytes written - numberOfBytesWritten = timelineEntityDataLength; - - return TimelinePacketStatus::Ok; -} - -TimelinePacketStatus WriteTimelineRelationshipBinary(ProfilingRelationshipType relationshipType, - uint64_t relationshipGuid, - uint64_t headGuid, - uint64_t tailGuid, - uint64_t attributeGuid, - unsigned char* buffer, - unsigned int remainingBufferSize, - unsigned int& numberOfBytesWritten) -{ - // Initialize the output value - numberOfBytesWritten = 0; - - // Check that the given buffer is valid - if (buffer == nullptr || remainingBufferSize == 0) - { - return TimelinePacketStatus::BufferExhaustion; - } - - // Utils - unsigned int uint32_t_size = sizeof(uint32_t); - unsigned int uint64_t_size = sizeof(uint64_t); - - // Calculate the length of the data (in bytes) - unsigned int timelineRelationshipDataLength = uint32_t_size * 2 + // decl_id + Relationship Type - uint64_t_size * 4; // Relationship GUID + Head GUID + - // tail GUID + attributeGuid - - // Check whether the timeline binary fits in the given buffer - if (timelineRelationshipDataLength > remainingBufferSize) - { - return TimelinePacketStatus::BufferExhaustion; - } - - // Initialize the offset for writing in the buffer - unsigned int offset = 0; - - uint32_t relationshipTypeUint = 0; - - switch (relationshipType) - { - case ProfilingRelationshipType::RetentionLink: - relationshipTypeUint = 0; - break; - case ProfilingRelationshipType::ExecutionLink: - relationshipTypeUint = 1; - break; - case ProfilingRelationshipType::DataLink: - relationshipTypeUint = 2; - break; - case ProfilingRelationshipType::LabelLink: - relationshipTypeUint = 3; - break; - default: - throw arm::pipe::InvalidArgumentException("Unknown relationship type given."); - } - - // Write the timeline binary payload to the buffer - // decl_id of the timeline message - uint32_t declId = 3; - WriteUint32(buffer, offset, declId); // decl_id - offset += uint32_t_size; - WriteUint32(buffer, offset, relationshipTypeUint); // Relationship Type - offset += uint32_t_size; - WriteUint64(buffer, offset, relationshipGuid); // GUID of this relationship - offset += uint64_t_size; - WriteUint64(buffer, offset, headGuid); // head of relationship GUID - offset += uint64_t_size; - WriteUint64(buffer, offset, tailGuid); // tail of relationship GUID - offset += uint64_t_size; - WriteUint64(buffer, offset, attributeGuid); // attribute of relationship GUID - - - // Update the number of bytes written - numberOfBytesWritten = timelineRelationshipDataLength; - - return TimelinePacketStatus::Ok; -} - -TimelinePacketStatus WriteTimelineMessageDirectoryPackage(unsigned char* buffer, - unsigned int remainingBufferSize, - unsigned int& numberOfBytesWritten) -{ - // Initialize the output value - numberOfBytesWritten = 0; - - // Check that the given buffer is valid - if (buffer == nullptr || remainingBufferSize == 0) - { - return TimelinePacketStatus::BufferExhaustion; - } - - // Utils - unsigned int uint8_t_size = sizeof(uint8_t); - unsigned int uint32_t_size = sizeof(uint32_t); - unsigned int uint64_t_size = sizeof(uint64_t); - - // The payload/data of the packet consists of swtrace event definitions encoded according - // to the swtrace directory specification. The messages being the five defined below: - // - // | decl_id | decl_name | ui_name | arg_types | arg_names | - // |-----------|---------------------|-----------------------|-------------|-------------------------------------| - // | 0 | declareLabel | declare label | ps | guid,value | - // | 1 | declareEntity | declare entity | p | guid | - // | 2 | declareEventClass | declare event class | pp | guid,nameGuid | - // | 3 | declareRelationship | declare relationship | Ipppp | relationshipType,relationshipGuid, | - // | | | | | headGuid,tailGuid,attributeGuid | - // | 4 | declareEvent | declare event | @tp | timestamp,threadId,eventGuid | - std::vector> timelineDirectoryMessages - { - { "0", "declareLabel", "declare label", "ps", "guid,value" }, - { "1", "declareEntity", "declare entity", "p", "guid" }, - { "2", "declareEventClass", "declare event class", "pp", "guid,nameGuid" }, - { "3", "declareRelationship", "declare relationship", "Ipppp", - "relationshipType,relationshipGuid,headGuid,tailGuid,attributeGuid" }, - { "4", "declareEvent", "declare event", "@tp", "timestamp,threadId,eventGuid" } - }; - - // Build the message declarations - std::vector swTraceBuffer; - for (const auto& directoryComponent : timelineDirectoryMessages) - { - // decl_id - uint32_t declId = 0; - try - { - declId = arm::pipe::numeric_cast(std::stoul(directoryComponent[0])); - } - catch (const std::exception&) - { - return TimelinePacketStatus::Error; - } - swTraceBuffer.push_back(declId); - - bool result = true; - result &= arm::pipe::ConvertDirectoryComponent( - directoryComponent[1], swTraceBuffer); // decl_name - result &= arm::pipe::ConvertDirectoryComponent ( - directoryComponent[2], swTraceBuffer); // ui_name - result &= arm::pipe::ConvertDirectoryComponent( - directoryComponent[3], swTraceBuffer); // arg_types - result &= arm::pipe::ConvertDirectoryComponent ( - directoryComponent[4], swTraceBuffer); // arg_names - if (!result) - { - return TimelinePacketStatus::Error; - } - } - - unsigned int dataLength = 3 * uint8_t_size + // Stream header (3 bytes) - arm::pipe::numeric_cast(swTraceBuffer.size()) * - uint32_t_size; // Trace directory (5 messages) - - // Calculate the timeline directory binary packet size (in bytes) - unsigned int timelineDirectoryPacketSize = 2 * uint32_t_size + // Header (2 words) - dataLength; // Payload - - // Check whether the timeline directory binary packet fits in the given buffer - if (timelineDirectoryPacketSize > remainingBufferSize) - { - return TimelinePacketStatus::BufferExhaustion; - } - - // Create packet header - auto packetHeader = CreateTimelinePacketHeader(1, 0, 0, 0, 0, arm::pipe::numeric_cast(dataLength)); - - // Initialize the offset for writing in the buffer - unsigned int offset = 0; - - // Write the timeline binary packet header to the buffer - WriteUint32(buffer, offset, packetHeader.first); - offset += uint32_t_size; - WriteUint32(buffer, offset, packetHeader.second); - offset += uint32_t_size; - - // Write the stream header - uint8_t streamVersion = 4; - uint8_t pointerBytes = arm::pipe::numeric_cast(uint64_t_size); // All GUIDs are uint64_t - uint8_t threadIdBytes = arm::pipe::numeric_cast(ThreadIdSize); - switch (threadIdBytes) - { - case 4: // Typically Windows and Android - case 8: // Typically Linux - break; // Valid values - default: - return TimelinePacketStatus::Error; // Invalid value - } - WriteUint8(buffer, offset, streamVersion); - offset += uint8_t_size; - WriteUint8(buffer, offset, pointerBytes); - offset += uint8_t_size; - WriteUint8(buffer, offset, threadIdBytes); - offset += uint8_t_size; - - // Write the SWTrace directory - uint32_t numberOfDeclarations = arm::pipe::numeric_cast(timelineDirectoryMessages.size()); - WriteUint32(buffer, offset, numberOfDeclarations); // Number of declarations - offset += uint32_t_size; - for (uint32_t i : swTraceBuffer) - { - WriteUint32(buffer, offset, i); // Message declarations - offset += uint32_t_size; - } - - // Update the number of bytes written - numberOfBytesWritten = timelineDirectoryPacketSize; - - return TimelinePacketStatus::Ok; -} - -TimelinePacketStatus WriteTimelineEventClassBinary(uint64_t profilingGuid, - uint64_t nameGuid, - unsigned char* buffer, - unsigned int remainingBufferSize, - unsigned int& numberOfBytesWritten) -{ - // Initialize the output value - numberOfBytesWritten = 0; - - // Check that the given buffer is valid - if (buffer == nullptr || remainingBufferSize == 0) - { - return TimelinePacketStatus::BufferExhaustion; - } - - // Utils - unsigned int uint32_t_size = sizeof(uint32_t); - unsigned int uint64_t_size = sizeof(uint64_t); - - // decl_id of the timeline message - uint32_t declId = 2; - - // Calculate the length of the data (in bytes) - unsigned int dataSize = uint32_t_size + (uint64_t_size * 2); // decl_id + Profiling GUID + Name GUID - - // Check whether the timeline binary fits in the given buffer - if (dataSize > remainingBufferSize) - { - return TimelinePacketStatus::BufferExhaustion; - } - - // Initialize the offset for writing in the buffer - unsigned int offset = 0; - - // Write the timeline binary payload to the buffer - WriteUint32(buffer, offset, declId); // decl_id - offset += uint32_t_size; - WriteUint64(buffer, offset, profilingGuid); // Profiling GUID - offset += uint64_t_size; - WriteUint64(buffer, offset, nameGuid); // Name GUID - - // Update the number of bytes written - numberOfBytesWritten = dataSize; - - return TimelinePacketStatus::Ok; -} - -TimelinePacketStatus WriteTimelineEventBinary(uint64_t timestamp, - int threadId, - uint64_t profilingGuid, - unsigned char* buffer, - unsigned int remainingBufferSize, - unsigned int& numberOfBytesWritten) -{ - // Initialize the output value - numberOfBytesWritten = 0; - // Check that the given buffer is valid - if (buffer == nullptr || remainingBufferSize == 0) - { - return TimelinePacketStatus::BufferExhaustion; - } - - // Utils - unsigned int uint32_t_size = sizeof(uint32_t); - unsigned int uint64_t_size = sizeof(uint64_t); - - // decl_id of the timeline message - uint32_t declId = 4; - - // Calculate the length of the data (in bytes) - unsigned int timelineEventDataLength = uint32_t_size + // decl_id - uint64_t_size + // Timestamp - ThreadIdSize + // Thread id - uint64_t_size; // Profiling GUID - - // Check whether the timeline binary packet fits in the given buffer - if (timelineEventDataLength > remainingBufferSize) - { - return TimelinePacketStatus::BufferExhaustion; - } - - // Initialize the offset for writing in the buffer - unsigned int offset = 0; - - // Write the timeline binary payload to the buffer - WriteUint32(buffer, offset, declId); // decl_id - offset += uint32_t_size; - WriteUint64(buffer, offset, timestamp); // Timestamp - offset += uint64_t_size; - WriteBytes(buffer, offset, &threadId, ThreadIdSize); // Thread id - offset += ThreadIdSize; - WriteUint64(buffer, offset, profilingGuid); // Profiling GUID - offset += uint64_t_size; - // Update the number of bytes written - numberOfBytesWritten = timelineEventDataLength; - - return TimelinePacketStatus::Ok; -} - -uint64_t GetTimestamp() -{ -#if USE_CLOCK_MONOTONIC_RAW - using clock = armnn::MonotonicClockRaw; -#else - using clock = std::chrono::steady_clock; -#endif - - // Take a timestamp - auto timestamp = std::chrono::duration_cast(clock::now().time_since_epoch()); - - return static_cast(timestamp.count()); -} - -arm::pipe::Packet ReceivePacket(const unsigned char* buffer, uint32_t length) -{ - if (buffer == nullptr) - { - throw arm::pipe::ProfilingException("data buffer is nullptr"); - } - if (length < 8) - { - throw arm::pipe::ProfilingException("length of data buffer is less than 8"); - } - - uint32_t metadataIdentifier = 0; - std::memcpy(&metadataIdentifier, buffer, sizeof(metadataIdentifier)); - - uint32_t dataLength = 0; - std::memcpy(&dataLength, buffer + 4u, sizeof(dataLength)); - - std::unique_ptr packetData; - if (dataLength > 0) - { - packetData = std::make_unique(dataLength); - std::memcpy(packetData.get(), buffer + 8u, dataLength); - } - - return arm::pipe::Packet(metadataIdentifier, dataLength, packetData); -} - -} // namespace pipe - -} // namespace arm - -namespace std -{ - -bool operator==(const std::vector& left, int right) -{ - return std::memcmp(left.data(), &right, left.size()) == 0; -} - -} // namespace std -- cgit v1.2.1