IVGCVSW-3929 Create the Timeline Event Class Binary Packet

* Added some utility functions
* Added WriteTimelineEventClassBinaryPacket
* Added related unit tests

Signed-off-by: Jan Eilers <jan.eilers@arm.com>
Change-Id: Ib1fca3f8642bf5bbddb5ce51f2d90581a86359b1

1 files changed, 90 insertions, 0 deletions

diff --git a/src/profiling/test/TimelinePacketTests.cpp b/src/profiling/test/TimelinePacketTests.cpp
index b039c373b2..d7a8e46df8 100644
--- a/src/profiling/test/TimelinePacketTests.cpp
+++ b/src/profiling/test/TimelinePacketTests.cpp
@@ -342,4 +342,94 @@ BOOST_AUTO_TEST_CASE(TimelineEntityPacketTest4)
     BOOST_CHECK(readProfilingGuid == profilingGuid);
 }
 
+BOOST_AUTO_TEST_SUITE_END()
+
+
+BOOST_AUTO_TEST_SUITE(TimelineEventClassTests)
+
+BOOST_AUTO_TEST_CASE(TimelineEventClassTest1)
+{
+    const uint64_t profilingGuid = 123456u;
+    unsigned int numberOfBytesWritten = 789u;
+    TimelinePacketStatus result = WriteTimelineEventClassBinaryPacket(profilingGuid,
+                                                                      nullptr,
+                                                                      512u,
+                                                                      numberOfBytesWritten);
+    BOOST_CHECK(result == TimelinePacketStatus::BufferExhaustion);
+    BOOST_CHECK(numberOfBytesWritten == 0);
+}
+
+BOOST_AUTO_TEST_CASE(TimelineEventClassTest2)
+{
+    std::vector<unsigned char> buffer(512, 0);
+
+    const uint64_t profilingGuid = 123456u;
+    unsigned int numberOfBytesWritten = 789u;
+    TimelinePacketStatus result = WriteTimelineEventClassBinaryPacket(profilingGuid,
+                                                                      buffer.data(),
+                                                                      0,
+                                                                      numberOfBytesWritten);
+    BOOST_CHECK(result == TimelinePacketStatus::BufferExhaustion);
+    BOOST_CHECK(numberOfBytesWritten == 0);
+}
+
+BOOST_AUTO_TEST_CASE(TimelineEventClassTest3)
+{
+    std::vector<unsigned char> buffer(10, 0);
+
+    const uint64_t profilingGuid = 123456u;
+    unsigned int numberOfBytesWritten = 789u;
+    TimelinePacketStatus result = WriteTimelineEventClassBinaryPacket(profilingGuid,
+                                                                      buffer.data(),
+                                                                      boost::numeric_cast<unsigned int>(buffer.size()),
+                                                                      numberOfBytesWritten);
+    BOOST_CHECK(result == TimelinePacketStatus::BufferExhaustion);
+    BOOST_CHECK(numberOfBytesWritten == 0);
+}
+
+BOOST_AUTO_TEST_CASE(TimelineEventClassTest4)
+{
+    std::vector<unsigned char> buffer(512, 0);
+
+    const uint64_t profilingGuid = 123456u;
+    unsigned int numberOfBytesWritten = 789u;
+    TimelinePacketStatus result = WriteTimelineEventClassBinaryPacket(profilingGuid,
+                                                                      buffer.data(),
+                                                                      boost::numeric_cast<unsigned int>(buffer.size()),
+                                                                      numberOfBytesWritten);
+    BOOST_CHECK(result == TimelinePacketStatus::Ok);
+    BOOST_CHECK(numberOfBytesWritten == 20);
+
+    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       == 12);
+
+    // Check the decl_id
+    offset += uint32_t_size;
+    uint32_t declId = ReadUint32(buffer.data(), offset);
+    BOOST_CHECK(declId == uint32_t(2));
+
+    // 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