From f21f606ac60fca82a320de6a706e69d84d3c895c Mon Sep 17 00:00:00 2001 From: David Monahan Date: Mon, 7 Oct 2019 15:11:15 +0100 Subject: IVGCVSW-3928 Add the Timeline Entity Binary Packet Signed-off-by: David Monahan Change-Id: If3dda4c5ba5c79e4bade58e14fc4df677cb2f5a1 --- src/profiling/ProfilingUtils.cpp | 74 ++++++++++++++++++++++++++ src/profiling/ProfilingUtils.hpp | 5 ++ src/profiling/test/TimelinePacketTests.cpp | 84 ++++++++++++++++++++++++++++++ 3 files changed, 163 insertions(+) (limited to 'src/profiling') diff --git a/src/profiling/ProfilingUtils.cpp b/src/profiling/ProfilingUtils.cpp index 23386f86f4..0f6432e091 100644 --- a/src/profiling/ProfilingUtils.cpp +++ b/src/profiling/ProfilingUtils.cpp @@ -331,6 +331,80 @@ TimelinePacketStatus WriteTimelineLabelBinaryPacket(uint64_t profilingGuid, return TimelinePacketStatus::Ok; } +TimelinePacketStatus WriteTimelineEntityBinaryPacket(uint64_t profilingGuid, + unsigned char* buffer, + unsigned int bufferSize, + unsigned int& numberOfBytesWritten) +{ + // Initialize the ouput value + numberOfBytesWritten = 0; + + // Check that the given buffer is valid + if (buffer == nullptr || bufferSize == 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 timelineEntityPacketDataLength = uint64_t_size; // Profiling GUID + + + // Calculate the timeline binary packet size (in bytes) + unsigned int timelineEntityPacketSize = 2 * uint32_t_size + // Header (2 words) + timelineEntityPacketDataLength; // Profiling GUID + + // Check whether the timeline binary packet fits in the given buffer + if (timelineEntityPacketSize > bufferSize) + { + return TimelinePacketStatus::BufferExhaustion; + } + + // 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 packetFamily = 1; + uint32_t packetClass = 0; + uint32_t packetType = 1; + uint32_t streamId = 0; + 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 sequenceNumbered = 0; + uint32_t dataLength = boost::numeric_cast(timelineEntityPacketDataLength); // Profiling GUID + uint32_t packetHeaderWord1 = ((sequenceNumbered & 0x00000001) << 24) | + ((dataLength & 0x00FFFFFF) << 0); + + // Initialize the offset for writing in the buffer + unsigned int offset = 0; + + // Write the timeline binary packet header to the buffer + WriteUint32(buffer, offset, packetHeaderWord0); + offset += uint32_t_size; + WriteUint32(buffer, offset, packetHeaderWord1); + 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 = timelineEntityPacketSize; + + return TimelinePacketStatus::Ok; +} + } // namespace profiling } // namespace armnn diff --git a/src/profiling/ProfilingUtils.hpp b/src/profiling/ProfilingUtils.hpp index 5afe6d8ead..b6a4de92f7 100644 --- a/src/profiling/ProfilingUtils.hpp +++ b/src/profiling/ProfilingUtils.hpp @@ -132,6 +132,11 @@ TimelinePacketStatus WriteTimelineLabelBinaryPacket(uint64_t profilingGuid, unsigned int bufferSize, unsigned int& numberOfBytesWritten); +TimelinePacketStatus WriteTimelineEntityBinaryPacket(uint64_t profilingGuid, + unsigned char* buffer, + unsigned int bufferSize, + unsigned int& numberOfBytesWritten); + class BufferExhaustion : public armnn::Exception { using Exception::Exception; diff --git a/src/profiling/test/TimelinePacketTests.cpp b/src/profiling/test/TimelinePacketTests.cpp index 82d4dca13f..24d665db9c 100644 --- a/src/profiling/test/TimelinePacketTests.cpp +++ b/src/profiling/test/TimelinePacketTests.cpp @@ -131,3 +131,87 @@ BOOST_AUTO_TEST_CASE(TimelineLabelPacketTest5) } BOOST_AUTO_TEST_SUITE_END() + +BOOST_AUTO_TEST_SUITE(TimelineEntityTests) + +BOOST_AUTO_TEST_CASE(TimelineEntityPacketTest1) +{ + const uint64_t profilingGuid = 123456u; + unsigned int numberOfBytesWritten = 789u; + TimelinePacketStatus result = WriteTimelineEntityBinaryPacket(profilingGuid, + nullptr, + 512u, + numberOfBytesWritten); + BOOST_CHECK(result == TimelinePacketStatus::BufferExhaustion); + BOOST_CHECK(numberOfBytesWritten == 0); +} + +BOOST_AUTO_TEST_CASE(TimelineEntityPacketTest2) +{ + std::vector buffer(512, 0); + + const uint64_t profilingGuid = 123456u; + unsigned int numberOfBytesWritten = 789u; + TimelinePacketStatus result = WriteTimelineEntityBinaryPacket(profilingGuid, + buffer.data(), + 0, + numberOfBytesWritten); + BOOST_CHECK(result == TimelinePacketStatus::BufferExhaustion); + BOOST_CHECK(numberOfBytesWritten == 0); +} + +BOOST_AUTO_TEST_CASE(TimelineEntityPacketTest3) +{ + std::vector buffer(10, 0); + + const uint64_t profilingGuid = 123456u; + unsigned int numberOfBytesWritten = 789u; + TimelinePacketStatus result = WriteTimelineEntityBinaryPacket(profilingGuid, + buffer.data(), + boost::numeric_cast(buffer.size()), + numberOfBytesWritten); + BOOST_CHECK(result == TimelinePacketStatus::BufferExhaustion); + BOOST_CHECK(numberOfBytesWritten == 0); +} + +BOOST_AUTO_TEST_CASE(TimelineEntityPacketTest4) +{ + std::vector buffer(512, 0); + + const uint64_t profilingGuid = 123456u; + unsigned int numberOfBytesWritten = 789u; + TimelinePacketStatus result = WriteTimelineEntityBinaryPacket(profilingGuid, + buffer.data(), + boost::numeric_cast(buffer.size()), + numberOfBytesWritten); + BOOST_CHECK(result == TimelinePacketStatus::Ok); + BOOST_CHECK(numberOfBytesWritten == 16); + + unsigned int uint32_t_size = sizeof(uint32_t); + + // Check the packet header + unsigned int offset = 0; + uint32_t packetHeaderWord0 = ReadUint32(buffer.data(), offset); + uint32_t packetFamily = (packetHeaderWord0 >> 26) & 0x0000003F; + uint32_t packetClass = (packetHeaderWord0 >> 19) & 0x0000007F; + uint32_t packetType = (packetHeaderWord0 >> 16) & 0x00000007; + uint32_t streamId = (packetHeaderWord0 >> 0) & 0x00000007; + BOOST_CHECK(packetFamily == 1); + BOOST_CHECK(packetClass == 0); + BOOST_CHECK(packetType == 1); + BOOST_CHECK(streamId == 0); + + offset += uint32_t_size; + uint32_t packetHeaderWord1 = ReadUint32(buffer.data(), offset); + uint32_t sequenceNumbered = (packetHeaderWord1 >> 24) & 0x00000001; + uint32_t dataLength = (packetHeaderWord1 >> 0) & 0x00FFFFFF; + BOOST_CHECK(sequenceNumbered == 0); + BOOST_CHECK(dataLength == 8); + + // Check the profiling GUID + offset += uint32_t_size; + uint64_t readProfilingGuid = ReadUint64(buffer.data(), offset); + BOOST_CHECK(readProfilingGuid == profilingGuid); +} + +BOOST_AUTO_TEST_SUITE_END() \ No newline at end of file -- cgit v1.2.1