IVGCVSW-3926 Create the Timeline Message Directory Package

Signed-off-by: Sadik Armagan <sadik.armagan@arm.com>
Change-Id: I8be40f2e6f1f916b2566ca4d9e87b38d27eb7730

1 files changed, 128 insertions, 0 deletions

diff --git a/src/profiling/test/TimelinePacketTests.cpp b/src/profiling/test/TimelinePacketTests.cpp
index 24d665db9c..b039c373b2 100644
--- a/src/profiling/test/TimelinePacketTests.cpp
+++ b/src/profiling/test/TimelinePacketTests.cpp
@@ -130,6 +130,134 @@ BOOST_AUTO_TEST_CASE(TimelineLabelPacketTest5)
     BOOST_CHECK(buffer[offset] == '\0'); // The null-terminator at the end of the SWTrace label
 }
 
+BOOST_AUTO_TEST_CASE(TimelineMessageDirectoryPacketTest1)
+{
+    unsigned int numberOfBytesWritten = 789u;
+    TimelinePacketStatus result = WriteTimelineMessageDirectoryPackage(nullptr,
+                                                                       512u,
+                                                                       numberOfBytesWritten);
+    BOOST_CHECK(result == TimelinePacketStatus::BufferExhaustion);
+    BOOST_CHECK(numberOfBytesWritten == 0);
+}
+
+BOOST_AUTO_TEST_CASE(TimelineMessageDirectoryPacketTest2)
+{
+    std::vector<unsigned char> buffer(512, 0);
+
+    unsigned int numberOfBytesWritten = 789u;
+    TimelinePacketStatus result = WriteTimelineMessageDirectoryPackage(buffer.data(),
+                                                                       0,
+                                                                       numberOfBytesWritten);
+    BOOST_CHECK(result == TimelinePacketStatus::BufferExhaustion);
+    BOOST_CHECK(numberOfBytesWritten == 0);
+}
+
+BOOST_AUTO_TEST_CASE(TimelineMessageDirectoryPacketTest3)
+{
+    std::vector<unsigned char> buffer(512, 0);
+    unsigned int numberOfBytesWritten = 789u;
+    TimelinePacketStatus result = WriteTimelineMessageDirectoryPackage(buffer.data(),
+                                                                       boost::numeric_cast<unsigned int>(buffer.size()),
+                                                                       numberOfBytesWritten);
+    BOOST_CHECK(result == TimelinePacketStatus::Ok);
+
+    BOOST_CHECK(numberOfBytesWritten == 424);
+
+    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   == 0);
+    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       == 416);
+
+    // Check the decl_id
+    offset += uint32_t_size;
+    uint32_t readDeclId = ReadUint32(buffer.data(), offset);
+    BOOST_CHECK(readDeclId == 0);
+
+    // SWTrace "namestring" format
+    // length of the string (first 4 bytes) + string + null terminator
+
+    // Check the decl_name
+    offset += uint32_t_size;
+    uint32_t swTraceDeclNameLength = ReadUint32(buffer.data(), offset);
+    BOOST_CHECK(swTraceDeclNameLength == 13); // decl_name length including the null-terminator
+
+    std::string label = "declareLabel";
+    offset += uint32_t_size;
+    BOOST_CHECK(std::memcmp(buffer.data() + offset,           // Offset to the label in the buffer
+                            label.data(),                      // The original label
+                            swTraceDeclNameLength - 1) == 0); // The length of the label
+
+    // Check the ui_name
+    std::vector<uint32_t> swTraceString;
+    StringToSwTraceString<SwTraceCharPolicy>(label, swTraceString);
+    offset += (boost::numeric_cast<unsigned int>(swTraceString.size()) - 1) * uint32_t_size;
+    uint32_t swTraceUINameLength = ReadUint32(buffer.data(), offset);
+    BOOST_CHECK(swTraceUINameLength == 14); // ui_name length including the null-terminator
+
+    label = "declare label";
+    offset += uint32_t_size;
+    BOOST_CHECK(std::memcmp(buffer.data() + offset,           // Offset to the label in the buffer
+                            label.data(),                     // The original label
+                            swTraceUINameLength - 1) == 0);   // The length of the label
+
+    // Check arg_types
+    StringToSwTraceString<SwTraceCharPolicy>(label, swTraceString);
+    offset += (boost::numeric_cast<unsigned int>(swTraceString.size()) - 1) * uint32_t_size;
+    uint32_t swTraceArgTypesLength = ReadUint32(buffer.data(), offset);
+    BOOST_CHECK(swTraceArgTypesLength == 3); // arg_types length including the null-terminator
+
+    label = "ps";
+    offset += uint32_t_size;
+    BOOST_CHECK(std::memcmp(buffer.data() + offset,           // Offset to the label in the buffer
+                            label.data(),                     // The original label
+                            swTraceArgTypesLength - 1) == 0); // The length of the label
+
+    // Check arg_names
+    StringToSwTraceString<SwTraceCharPolicy>(label, swTraceString);
+    offset += (boost::numeric_cast<unsigned int>(swTraceString.size()) - 1) * uint32_t_size;
+    uint32_t swTraceArgNamesLength = ReadUint32(buffer.data(), offset);
+    BOOST_CHECK(swTraceArgNamesLength == 11); // arg_names length including the null-terminator
+
+    label = "guid,value";
+    offset += uint32_t_size;
+    BOOST_CHECK(std::memcmp(buffer.data() + offset,        // Offset to the label in the buffer
+                            label.data(),                     // The original label
+                            swTraceArgNamesLength - 1) == 0); // The length of the label
+
+    // Check second message decl_id
+    StringToSwTraceString<SwTraceCharPolicy>(label, swTraceString);
+    offset += (boost::numeric_cast<unsigned int>(swTraceString.size()) - 1) * uint32_t_size;
+    readDeclId = ReadUint32(buffer.data(), offset);
+    BOOST_CHECK(readDeclId == 1);
+
+    // Check second decl_name
+    offset += uint32_t_size;
+    swTraceDeclNameLength = ReadUint32(buffer.data(), offset);
+    BOOST_CHECK(swTraceDeclNameLength == 14); // decl_name length including the null-terminator
+
+    label = "declareEntity";
+    offset += uint32_t_size;
+    BOOST_CHECK(std::memcmp(buffer.data() + offset,           // Offset to the label in the buffer
+                            label.data(),                     // The original label
+                            swTraceDeclNameLength - 1) == 0); // The length of the label
+}
+
 BOOST_AUTO_TEST_SUITE_END()
 
 BOOST_AUTO_TEST_SUITE(TimelineEntityTests)