IVGCVSW-3927 Create the Timeline Label Binary Packet
* Added a new utility function to create a Timeline Label
Binary Packet and write it to a given buffer
* Added new enumeration to be reused for subsequent utility
functions
* Added unit tests
Signed-off-by: Matteo Martincigh <matteo.martincigh@arm.com>
Change-Id: Icbabefb9050f3f3b1a30082eabf875593378001f
diff --git a/src/profiling/ProfilingUtils.cpp b/src/profiling/ProfilingUtils.cpp
index 588fcc1..23386f8 100644
--- a/src/profiling/ProfilingUtils.cpp
+++ b/src/profiling/ProfilingUtils.cpp
@@ -239,6 +239,98 @@
return name;
}
+TimelinePacketStatus WriteTimelineLabelBinaryPacket(uint64_t profilingGuid,
+ const std::string& label,
+ 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);
+
+ // Convert the label into a SWTrace string
+ std::vector<uint32_t> swTraceLabel;
+ bool result = StringToSwTraceString<SwTraceCharPolicy>(label, swTraceLabel);
+ if (!result)
+ {
+ return TimelinePacketStatus::Error;
+ }
+
+ // Calculate the size of the SWTrace string label (in bytes)
+ unsigned int swTraceLabelSize = boost::numeric_cast<unsigned int>(swTraceLabel.size()) * uint32_t_size;
+
+ // Calculate the length of the data (in bytes)
+ unsigned int timelineLabelPacketDataLength = uint64_t_size + // Profiling GUID
+ swTraceLabelSize; // Label
+
+ // Calculate the timeline binary packet size (in bytes)
+ unsigned int timelineLabelPacketSize = 2 * uint32_t_size + // Header (2 words)
+ timelineLabelPacketDataLength; // Profiling GUID + label
+
+ // Check whether the timeline binary packet fits in the given buffer
+ if (timelineLabelPacketSize > 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<uint32_t>(timelineLabelPacketDataLength); // Profiling GUID + label
+ 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
+ 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 = timelineLabelPacketSize;
+
+ return TimelinePacketStatus::Ok;
+}
+
} // namespace profiling
} // namespace armnn