Matteo Martincigh | 830101c | 2019-10-22 11:07:45 +0100 | [diff] [blame] | 1 | // |
Jim Flynn | 6398a98 | 2020-05-27 17:05:21 +0100 | [diff] [blame^] | 2 | // Copyright © 2019 Arm Ltd and Contributors. All rights reserved. |
Matteo Martincigh | 830101c | 2019-10-22 11:07:45 +0100 | [diff] [blame] | 3 | // SPDX-License-Identifier: MIT |
| 4 | // |
| 5 | |
Jim Flynn | 6406355 | 2020-02-14 10:18:08 +0000 | [diff] [blame] | 6 | #include "ProfilingMocks.hpp" |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 7 | #include "ProfilingTestUtils.hpp" |
Matteo Martincigh | 830101c | 2019-10-22 11:07:45 +0100 | [diff] [blame] | 8 | |
| 9 | #include <SendTimelinePacket.hpp> |
| 10 | #include <TimelineUtilityMethods.hpp> |
Matteo Martincigh | 102cdbd | 2019-10-28 11:42:50 +0000 | [diff] [blame] | 11 | #include <LabelsAndEventClasses.hpp> |
Matteo Martincigh | c040199 | 2019-10-28 15:24:34 +0000 | [diff] [blame] | 12 | #include <ProfilingService.hpp> |
Matteo Martincigh | 830101c | 2019-10-22 11:07:45 +0100 | [diff] [blame] | 13 | |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 14 | #include <memory> |
| 15 | |
Matteo Martincigh | 830101c | 2019-10-22 11:07:45 +0100 | [diff] [blame] | 16 | #include <boost/test/unit_test.hpp> |
| 17 | |
| 18 | using namespace armnn; |
| 19 | using namespace armnn::profiling; |
| 20 | |
| 21 | BOOST_AUTO_TEST_SUITE(TimelineUtilityMethodsTests) |
| 22 | |
Matteo Martincigh | c040199 | 2019-10-28 15:24:34 +0000 | [diff] [blame] | 23 | BOOST_AUTO_TEST_CASE(CreateTypedLabelTest) |
| 24 | { |
| 25 | MockBufferManager mockBufferManager(1024); |
Sadik Armagan | 3184c90 | 2020-03-18 10:57:30 +0000 | [diff] [blame] | 26 | ProfilingService profilingService; |
| 27 | |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 28 | std::unique_ptr<ISendTimelinePacket> sendTimelinePacket = std::make_unique<SendTimelinePacket>(mockBufferManager); |
Sadik Armagan | 0a35667 | 2020-03-20 11:11:01 +0000 | [diff] [blame] | 29 | TimelineUtilityMethods timelineUtilityMethods(sendTimelinePacket); |
Matteo Martincigh | c040199 | 2019-10-28 15:24:34 +0000 | [diff] [blame] | 30 | |
Narumol Prangnawarat | dbdd1b4 | 2019-11-15 17:38:44 +0000 | [diff] [blame] | 31 | // Generate first guid to ensure that the named typed entity guid is not 0 on local single test. |
Sadik Armagan | 3184c90 | 2020-03-18 10:57:30 +0000 | [diff] [blame] | 32 | profilingService.NextGuid(); |
Narumol Prangnawarat | dbdd1b4 | 2019-11-15 17:38:44 +0000 | [diff] [blame] | 33 | |
Matteo Martincigh | c040199 | 2019-10-28 15:24:34 +0000 | [diff] [blame] | 34 | ProfilingGuid entityGuid(123); |
| 35 | const std::string entityName = "some entity"; |
| 36 | ProfilingStaticGuid labelTypeGuid(456); |
| 37 | |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 38 | BOOST_CHECK_NO_THROW(timelineUtilityMethods.MarkEntityWithLabel(entityGuid, entityName, labelTypeGuid)); |
Matteo Martincigh | c040199 | 2019-10-28 15:24:34 +0000 | [diff] [blame] | 39 | |
| 40 | // Commit all packets at once |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 41 | timelineUtilityMethods.Commit(); |
Matteo Martincigh | c040199 | 2019-10-28 15:24:34 +0000 | [diff] [blame] | 42 | |
| 43 | // Get the readable buffer |
| 44 | auto readableBuffer = mockBufferManager.GetReadableBuffer(); |
| 45 | BOOST_CHECK(readableBuffer != nullptr); |
| 46 | unsigned int size = readableBuffer->GetSize(); |
Finn Williams | 0a336dc | 2020-05-11 15:39:58 +0100 | [diff] [blame] | 47 | BOOST_CHECK(size == 76); |
Matteo Martincigh | c040199 | 2019-10-28 15:24:34 +0000 | [diff] [blame] | 48 | const unsigned char* readableData = readableBuffer->GetReadableData(); |
| 49 | BOOST_CHECK(readableData != nullptr); |
| 50 | |
| 51 | // Utils |
| 52 | unsigned int offset = 0; |
| 53 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 54 | // Verify Header |
Finn Williams | 0a336dc | 2020-05-11 15:39:58 +0100 | [diff] [blame] | 55 | VerifyTimelineHeaderBinary(readableData, offset, 68); |
Matteo Martincigh | c040199 | 2019-10-28 15:24:34 +0000 | [diff] [blame] | 56 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 57 | // First dataset sent: TimelineLabelBinaryPacket |
| 58 | VerifyTimelineLabelBinaryPacketData(EmptyOptional(), entityName, readableData, offset); |
Matteo Martincigh | c040199 | 2019-10-28 15:24:34 +0000 | [diff] [blame] | 59 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 60 | // Second dataset sent: TimelineRelationshipBinaryPacket |
| 61 | VerifyTimelineRelationshipBinaryPacketData(ProfilingRelationshipType::LabelLink, |
| 62 | EmptyOptional(), |
| 63 | entityGuid, |
| 64 | EmptyOptional(), |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 65 | labelTypeGuid, |
| 66 | readableData, |
| 67 | offset); |
Matteo Martincigh | c040199 | 2019-10-28 15:24:34 +0000 | [diff] [blame] | 68 | |
| 69 | // Mark the buffer as read |
| 70 | mockBufferManager.MarkRead(readableBuffer); |
| 71 | } |
| 72 | |
Matteo Martincigh | 102cdbd | 2019-10-28 11:42:50 +0000 | [diff] [blame] | 73 | BOOST_AUTO_TEST_CASE(SendWellKnownLabelsAndEventClassesTest) |
| 74 | { |
| 75 | MockBufferManager mockBufferManager(1024); |
Finn Williams | cf2ad55 | 2020-03-20 15:10:59 +0000 | [diff] [blame] | 76 | ProfilingService profilingService; |
| 77 | SendTimelinePacket sendTimelinePacket(mockBufferManager); |
Matteo Martincigh | 102cdbd | 2019-10-28 11:42:50 +0000 | [diff] [blame] | 78 | |
Finn Williams | cf2ad55 | 2020-03-20 15:10:59 +0000 | [diff] [blame] | 79 | BOOST_CHECK_NO_THROW(TimelineUtilityMethods::SendWellKnownLabelsAndEventClasses(sendTimelinePacket)); |
Matteo Martincigh | 102cdbd | 2019-10-28 11:42:50 +0000 | [diff] [blame] | 80 | |
| 81 | // Get the readable buffer |
| 82 | auto readableBuffer = mockBufferManager.GetReadableBuffer(); |
| 83 | BOOST_CHECK(readableBuffer != nullptr); |
| 84 | unsigned int size = readableBuffer->GetSize(); |
Jim Flynn | 6398a98 | 2020-05-27 17:05:21 +0100 | [diff] [blame^] | 85 | BOOST_TEST(size == 432); |
Matteo Martincigh | 102cdbd | 2019-10-28 11:42:50 +0000 | [diff] [blame] | 86 | const unsigned char* readableData = readableBuffer->GetReadableData(); |
| 87 | BOOST_CHECK(readableData != nullptr); |
| 88 | |
| 89 | // Utils |
| 90 | unsigned int offset = 0; |
| 91 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 92 | // Verify Header |
Jim Flynn | 6398a98 | 2020-05-27 17:05:21 +0100 | [diff] [blame^] | 93 | VerifyTimelineHeaderBinary(readableData, offset, 424); |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 94 | |
Matteo Martincigh | 102cdbd | 2019-10-28 11:42:50 +0000 | [diff] [blame] | 95 | // First "well-known" label: NAME |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 96 | VerifyTimelineLabelBinaryPacketData(LabelsAndEventClasses::NAME_GUID, |
| 97 | LabelsAndEventClasses::NAME_LABEL, |
| 98 | readableData, |
| 99 | offset); |
Matteo Martincigh | 102cdbd | 2019-10-28 11:42:50 +0000 | [diff] [blame] | 100 | |
| 101 | // Second "well-known" label: TYPE |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 102 | VerifyTimelineLabelBinaryPacketData(LabelsAndEventClasses::TYPE_GUID, |
| 103 | LabelsAndEventClasses::TYPE_LABEL, |
| 104 | readableData, |
| 105 | offset); |
Matteo Martincigh | 102cdbd | 2019-10-28 11:42:50 +0000 | [diff] [blame] | 106 | |
| 107 | // Third "well-known" label: INDEX |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 108 | VerifyTimelineLabelBinaryPacketData(LabelsAndEventClasses::INDEX_GUID, |
| 109 | LabelsAndEventClasses::INDEX_LABEL, |
| 110 | readableData, |
| 111 | offset); |
Matteo Martincigh | 102cdbd | 2019-10-28 11:42:50 +0000 | [diff] [blame] | 112 | |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 113 | // Forth "well-known" label: BACKENDID |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 114 | VerifyTimelineLabelBinaryPacketData(LabelsAndEventClasses::BACKENDID_GUID, |
| 115 | LabelsAndEventClasses::BACKENDID_LABEL, |
| 116 | readableData, |
| 117 | offset); |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 118 | |
Jim Flynn | 6398a98 | 2020-05-27 17:05:21 +0100 | [diff] [blame^] | 119 | // Fifth "well-known" label: CHILD |
| 120 | VerifyTimelineLabelBinaryPacketData(LabelsAndEventClasses::CHILD_GUID, |
| 121 | LabelsAndEventClasses::CHILD_LABEL, |
| 122 | readableData, |
| 123 | offset); |
| 124 | |
| 125 | // Sixth "well-known" label: EXECUTION_OF |
| 126 | VerifyTimelineLabelBinaryPacketData(LabelsAndEventClasses::EXECUTION_OF_GUID, |
| 127 | LabelsAndEventClasses::EXECUTION_OF_LABEL, |
| 128 | readableData, |
| 129 | offset); |
| 130 | |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 131 | // Well-known types |
| 132 | // Layer |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 133 | VerifyTimelineLabelBinaryPacketData(LabelsAndEventClasses::LAYER_GUID, |
| 134 | LabelsAndEventClasses::LAYER, |
| 135 | readableData, |
| 136 | offset); |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 137 | |
| 138 | // Workload |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 139 | VerifyTimelineLabelBinaryPacketData(LabelsAndEventClasses::WORKLOAD_GUID, |
| 140 | LabelsAndEventClasses::WORKLOAD, |
| 141 | readableData, |
| 142 | offset); |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 143 | |
| 144 | // Network |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 145 | VerifyTimelineLabelBinaryPacketData(LabelsAndEventClasses::NETWORK_GUID, |
| 146 | LabelsAndEventClasses::NETWORK, |
| 147 | readableData, |
| 148 | offset); |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 149 | |
| 150 | // Connection |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 151 | VerifyTimelineLabelBinaryPacketData(LabelsAndEventClasses::CONNECTION_GUID, |
| 152 | LabelsAndEventClasses::CONNECTION, |
| 153 | readableData, |
| 154 | offset); |
| 155 | |
David Monahan | 6198fe0 | 2019-12-02 08:35:43 +0000 | [diff] [blame] | 156 | // Inference |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 157 | VerifyTimelineLabelBinaryPacketData(LabelsAndEventClasses::INFERENCE_GUID, |
| 158 | LabelsAndEventClasses::INFERENCE, |
| 159 | readableData, |
| 160 | offset); |
| 161 | |
David Monahan | 6198fe0 | 2019-12-02 08:35:43 +0000 | [diff] [blame] | 162 | // Workload Execution |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 163 | VerifyTimelineLabelBinaryPacketData(LabelsAndEventClasses::WORKLOAD_EXECUTION_GUID, |
| 164 | LabelsAndEventClasses::WORKLOAD_EXECUTION, |
| 165 | readableData, |
| 166 | offset); |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 167 | |
Matteo Martincigh | 102cdbd | 2019-10-28 11:42:50 +0000 | [diff] [blame] | 168 | // First "well-known" event class: START OF LIFE |
Jim Flynn | 1892d21 | 2020-05-26 21:10:49 +0100 | [diff] [blame] | 169 | VerifyTimelineLabelBinaryPacketData(LabelsAndEventClasses::ARMNN_PROFILING_SOL_EVENT_CLASS_NAME_GUID, |
| 170 | LabelsAndEventClasses::ARMNN_PROFILING_SOL_EVENT_CLASS_NAME, |
| 171 | readableData, |
| 172 | offset); |
| 173 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 174 | VerifyTimelineEventClassBinaryPacketData(LabelsAndEventClasses::ARMNN_PROFILING_SOL_EVENT_CLASS, |
Jim Flynn | 1892d21 | 2020-05-26 21:10:49 +0100 | [diff] [blame] | 175 | LabelsAndEventClasses::ARMNN_PROFILING_SOL_EVENT_CLASS_NAME_GUID, |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 176 | readableData, |
| 177 | offset); |
Matteo Martincigh | 102cdbd | 2019-10-28 11:42:50 +0000 | [diff] [blame] | 178 | |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 179 | // Second "well-known" event class: END OF LIFE |
Jim Flynn | 1892d21 | 2020-05-26 21:10:49 +0100 | [diff] [blame] | 180 | VerifyTimelineLabelBinaryPacketData(LabelsAndEventClasses::ARMNN_PROFILING_EOL_EVENT_CLASS_NAME_GUID, |
| 181 | LabelsAndEventClasses::ARMNN_PROFILING_EOL_EVENT_CLASS_NAME, |
| 182 | readableData, |
| 183 | offset); |
| 184 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 185 | VerifyTimelineEventClassBinaryPacketData(LabelsAndEventClasses::ARMNN_PROFILING_EOL_EVENT_CLASS, |
Jim Flynn | 1892d21 | 2020-05-26 21:10:49 +0100 | [diff] [blame] | 186 | LabelsAndEventClasses::ARMNN_PROFILING_EOL_EVENT_CLASS_NAME_GUID, |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 187 | readableData, |
| 188 | offset); |
Matteo Martincigh | 102cdbd | 2019-10-28 11:42:50 +0000 | [diff] [blame] | 189 | |
| 190 | // Mark the buffer as read |
| 191 | mockBufferManager.MarkRead(readableBuffer); |
| 192 | } |
| 193 | |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 194 | BOOST_AUTO_TEST_CASE(CreateNamedTypedChildEntityTest) |
| 195 | { |
| 196 | MockBufferManager mockBufferManager(1024); |
Sadik Armagan | 3184c90 | 2020-03-18 10:57:30 +0000 | [diff] [blame] | 197 | ProfilingService profilingService; |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 198 | std::unique_ptr<ISendTimelinePacket> sendTimelinePacket = std::make_unique<SendTimelinePacket>(mockBufferManager); |
Sadik Armagan | 0a35667 | 2020-03-20 11:11:01 +0000 | [diff] [blame] | 199 | TimelineUtilityMethods timelineUtilityMethods(sendTimelinePacket); |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 200 | |
Narumol Prangnawarat | 234d525 | 2019-11-19 15:49:18 +0000 | [diff] [blame] | 201 | ProfilingDynamicGuid childEntityGuid(0); |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 202 | ProfilingGuid parentEntityGuid(123); |
| 203 | const std::string entityName = "some entity"; |
| 204 | const std::string entityType = "some type"; |
| 205 | |
Narumol Prangnawarat | dbdd1b4 | 2019-11-15 17:38:44 +0000 | [diff] [blame] | 206 | // Generate first guid to ensure that the named typed entity guid is not 0 on local single test. |
Sadik Armagan | 3184c90 | 2020-03-18 10:57:30 +0000 | [diff] [blame] | 207 | profilingService.NextGuid(); |
Narumol Prangnawarat | dbdd1b4 | 2019-11-15 17:38:44 +0000 | [diff] [blame] | 208 | |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 209 | BOOST_CHECK_THROW(timelineUtilityMethods.CreateNamedTypedChildEntity(parentEntityGuid, "", entityType), |
| 210 | InvalidArgumentException); |
| 211 | BOOST_CHECK_THROW(timelineUtilityMethods.CreateNamedTypedChildEntity(parentEntityGuid, entityName, ""), |
| 212 | InvalidArgumentException); |
Narumol Prangnawarat | 234d525 | 2019-11-19 15:49:18 +0000 | [diff] [blame] | 213 | BOOST_CHECK_THROW(timelineUtilityMethods.CreateNamedTypedChildEntity( |
| 214 | childEntityGuid, parentEntityGuid, "", entityType), InvalidArgumentException); |
| 215 | BOOST_CHECK_THROW(timelineUtilityMethods.CreateNamedTypedChildEntity( |
| 216 | childEntityGuid, parentEntityGuid, entityName, ""), InvalidArgumentException); |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 217 | |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 218 | BOOST_CHECK_NO_THROW(childEntityGuid = timelineUtilityMethods.CreateNamedTypedChildEntity(parentEntityGuid, |
| 219 | entityName, |
| 220 | entityType)); |
| 221 | BOOST_CHECK(childEntityGuid != ProfilingGuid(0)); |
| 222 | |
| 223 | // Commit all packets at once |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 224 | timelineUtilityMethods.Commit(); |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 225 | |
| 226 | // Get the readable buffer |
| 227 | auto readableBuffer = mockBufferManager.GetReadableBuffer(); |
| 228 | BOOST_CHECK(readableBuffer != nullptr); |
| 229 | unsigned int size = readableBuffer->GetSize(); |
Finn Williams | 0a336dc | 2020-05-11 15:39:58 +0100 | [diff] [blame] | 230 | BOOST_CHECK(size == 196); |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 231 | const unsigned char* readableData = readableBuffer->GetReadableData(); |
| 232 | BOOST_CHECK(readableData != nullptr); |
| 233 | |
| 234 | // Utils |
| 235 | unsigned int offset = 0; |
| 236 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 237 | // Verify Header |
Finn Williams | 0a336dc | 2020-05-11 15:39:58 +0100 | [diff] [blame] | 238 | VerifyTimelineHeaderBinary(readableData, offset, 188); |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 239 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 240 | // First dataset sent: TimelineEntityBinaryPacket |
| 241 | VerifyTimelineEntityBinaryPacketData(EmptyOptional(), readableData, offset); |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 242 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 243 | // Second dataset sent: TimelineLabelBinaryPacket |
| 244 | VerifyTimelineLabelBinaryPacketData(EmptyOptional(), entityName, readableData, offset); |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 245 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 246 | // Third dataset sent: TimelineRelationshipBinaryPacket |
| 247 | VerifyTimelineRelationshipBinaryPacketData(ProfilingRelationshipType::LabelLink, |
| 248 | EmptyOptional(), |
| 249 | EmptyOptional(), |
| 250 | EmptyOptional(), |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 251 | LabelsAndEventClasses::NAME_GUID, |
| 252 | readableData, |
| 253 | offset); |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 254 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 255 | // Fifth dataset sent: TimelineLabelBinaryPacket |
| 256 | VerifyTimelineLabelBinaryPacketData(EmptyOptional(), entityType, readableData, offset); |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 257 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 258 | // Sixth dataset sent: TimelineRelationshipBinaryPacket |
| 259 | VerifyTimelineRelationshipBinaryPacketData(ProfilingRelationshipType::LabelLink, |
| 260 | EmptyOptional(), |
| 261 | EmptyOptional(), |
| 262 | EmptyOptional(), |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 263 | LabelsAndEventClasses::TYPE_GUID, |
| 264 | readableData, |
| 265 | offset); |
| 266 | |
Finn Williams | 0a336dc | 2020-05-11 15:39:58 +0100 | [diff] [blame] | 267 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 268 | // Eighth dataset sent: TimelineRelationshipBinaryPacket |
| 269 | VerifyTimelineRelationshipBinaryPacketData(ProfilingRelationshipType::RetentionLink, |
| 270 | EmptyOptional(), |
| 271 | parentEntityGuid, |
| 272 | EmptyOptional(), |
Finn Williams | 0a336dc | 2020-05-11 15:39:58 +0100 | [diff] [blame] | 273 | EmptyOptional(), |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 274 | readableData, |
| 275 | offset); |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 276 | |
| 277 | // Mark the buffer as read |
| 278 | mockBufferManager.MarkRead(readableBuffer); |
| 279 | } |
| 280 | |
Matteo Martincigh | 102cdbd | 2019-10-28 11:42:50 +0000 | [diff] [blame] | 281 | BOOST_AUTO_TEST_CASE(DeclareLabelTest) |
Matteo Martincigh | 830101c | 2019-10-22 11:07:45 +0100 | [diff] [blame] | 282 | { |
| 283 | MockBufferManager mockBufferManager(1024); |
Sadik Armagan | 3184c90 | 2020-03-18 10:57:30 +0000 | [diff] [blame] | 284 | ProfilingService profilingService; |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 285 | std::unique_ptr<ISendTimelinePacket> sendTimelinePacket = std::make_unique<SendTimelinePacket>(mockBufferManager); |
Sadik Armagan | 0a35667 | 2020-03-20 11:11:01 +0000 | [diff] [blame] | 286 | TimelineUtilityMethods timelineUtilityMethods(sendTimelinePacket); |
Matteo Martincigh | 830101c | 2019-10-22 11:07:45 +0100 | [diff] [blame] | 287 | |
Narumol Prangnawarat | dbdd1b4 | 2019-11-15 17:38:44 +0000 | [diff] [blame] | 288 | // Generate first guid to ensure that the named typed entity guid is not 0 on local single test. |
Sadik Armagan | 3184c90 | 2020-03-18 10:57:30 +0000 | [diff] [blame] | 289 | profilingService.NextGuid(); |
Narumol Prangnawarat | dbdd1b4 | 2019-11-15 17:38:44 +0000 | [diff] [blame] | 290 | |
Matteo Martincigh | 830101c | 2019-10-22 11:07:45 +0100 | [diff] [blame] | 291 | // Try declaring an invalid (empty) label |
| 292 | BOOST_CHECK_THROW(timelineUtilityMethods.DeclareLabel(""), InvalidArgumentException); |
| 293 | |
| 294 | // Try declaring an invalid (wrong SWTrace format) label |
| 295 | BOOST_CHECK_THROW(timelineUtilityMethods.DeclareLabel("inv@lid lab€l"), RuntimeException); |
| 296 | |
| 297 | // Declare a valid label |
| 298 | const std::string labelName = "valid label"; |
| 299 | ProfilingGuid labelGuid = 0; |
| 300 | BOOST_CHECK_NO_THROW(labelGuid = timelineUtilityMethods.DeclareLabel(labelName)); |
Narumol Prangnawarat | dbdd1b4 | 2019-11-15 17:38:44 +0000 | [diff] [blame] | 301 | BOOST_CHECK(labelGuid != ProfilingGuid(0)); |
Matteo Martincigh | 830101c | 2019-10-22 11:07:45 +0100 | [diff] [blame] | 302 | |
Matteo Martincigh | 830101c | 2019-10-22 11:07:45 +0100 | [diff] [blame] | 303 | // Try adding the same label as before |
Narumol Prangnawarat | dbdd1b4 | 2019-11-15 17:38:44 +0000 | [diff] [blame] | 304 | ProfilingGuid newLabelGuid = 0; |
| 305 | BOOST_CHECK_NO_THROW(newLabelGuid = timelineUtilityMethods.DeclareLabel(labelName)); |
| 306 | BOOST_CHECK(newLabelGuid != ProfilingGuid(0)); |
| 307 | BOOST_CHECK(newLabelGuid == labelGuid); |
Matteo Martincigh | 830101c | 2019-10-22 11:07:45 +0100 | [diff] [blame] | 308 | } |
| 309 | |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 310 | BOOST_AUTO_TEST_CASE(CreateNameTypeEntityInvalidTest) |
| 311 | { |
| 312 | MockBufferManager mockBufferManager(1024); |
Sadik Armagan | 3184c90 | 2020-03-18 10:57:30 +0000 | [diff] [blame] | 313 | ProfilingService profilingService; |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 314 | std::unique_ptr<ISendTimelinePacket> sendTimelinePacket = std::make_unique<SendTimelinePacket>(mockBufferManager); |
Sadik Armagan | 0a35667 | 2020-03-20 11:11:01 +0000 | [diff] [blame] | 315 | TimelineUtilityMethods timelineUtilityMethods(sendTimelinePacket); |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 316 | |
| 317 | // Invalid name |
| 318 | BOOST_CHECK_THROW(timelineUtilityMethods.CreateNamedTypedEntity("", "Type"), InvalidArgumentException); |
| 319 | |
| 320 | // Invalid type |
| 321 | BOOST_CHECK_THROW(timelineUtilityMethods.CreateNamedTypedEntity("Name", ""), InvalidArgumentException); |
| 322 | |
Sadik Armagan | 3184c90 | 2020-03-18 10:57:30 +0000 | [diff] [blame] | 323 | ProfilingDynamicGuid guid = profilingService.NextGuid(); |
Narumol Prangnawarat | 234d525 | 2019-11-19 15:49:18 +0000 | [diff] [blame] | 324 | |
| 325 | // CreatedNamedTypedEntity with Guid - Invalid name |
| 326 | BOOST_CHECK_THROW(timelineUtilityMethods.CreateNamedTypedEntity(guid, "", "Type"), |
| 327 | InvalidArgumentException); |
| 328 | |
| 329 | // CreatedNamedTypedEntity with Guid - Invalid type |
| 330 | BOOST_CHECK_THROW(timelineUtilityMethods.CreateNamedTypedEntity(guid, "Name", ""), |
| 331 | InvalidArgumentException); |
| 332 | |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 333 | } |
| 334 | |
Matteo Martincigh | 5dc816e | 2019-11-04 14:05:28 +0000 | [diff] [blame] | 335 | BOOST_AUTO_TEST_CASE(CreateNameTypeEntityTest) |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 336 | { |
| 337 | MockBufferManager mockBufferManager(1024); |
Sadik Armagan | 3184c90 | 2020-03-18 10:57:30 +0000 | [diff] [blame] | 338 | ProfilingService profilingService; |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 339 | std::unique_ptr<ISendTimelinePacket> sendTimelinePacket = std::make_unique<SendTimelinePacket>(mockBufferManager); |
Sadik Armagan | 0a35667 | 2020-03-20 11:11:01 +0000 | [diff] [blame] | 340 | TimelineUtilityMethods timelineUtilityMethods(sendTimelinePacket); |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 341 | |
| 342 | const std::string entityName = "Entity0"; |
| 343 | const std::string entityType = "Type0"; |
| 344 | |
Narumol Prangnawarat | dbdd1b4 | 2019-11-15 17:38:44 +0000 | [diff] [blame] | 345 | // Generate first guid to ensure that the named typed entity guid is not 0 on local single test. |
Sadik Armagan | 3184c90 | 2020-03-18 10:57:30 +0000 | [diff] [blame] | 346 | profilingService.NextGuid(); |
Narumol Prangnawarat | dbdd1b4 | 2019-11-15 17:38:44 +0000 | [diff] [blame] | 347 | |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 348 | ProfilingDynamicGuid guid = timelineUtilityMethods.CreateNamedTypedEntity(entityName, entityType); |
| 349 | BOOST_CHECK(guid != ProfilingGuid(0)); |
| 350 | |
| 351 | // Commit all packets at once |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 352 | timelineUtilityMethods.Commit(); |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 353 | |
| 354 | // Get the readable buffer |
| 355 | auto readableBuffer = mockBufferManager.GetReadableBuffer(); |
| 356 | BOOST_CHECK(readableBuffer != nullptr); |
| 357 | unsigned int size = readableBuffer->GetSize(); |
Finn Williams | 0a336dc | 2020-05-11 15:39:58 +0100 | [diff] [blame] | 358 | BOOST_CHECK(size == 148); |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 359 | const unsigned char* readableData = readableBuffer->GetReadableData(); |
| 360 | BOOST_CHECK(readableData != nullptr); |
| 361 | |
| 362 | // Utils |
| 363 | unsigned int offset = 0; |
| 364 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 365 | // Verify Header |
Finn Williams | 0a336dc | 2020-05-11 15:39:58 +0100 | [diff] [blame] | 366 | VerifyTimelineHeaderBinary(readableData, offset, 140); |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 367 | |
| 368 | // First dataset sent: TimelineEntityBinaryPacket |
| 369 | VerifyTimelineEntityBinaryPacketData(guid, readableData, offset); |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 370 | |
| 371 | // Packets for Name Entity |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 372 | // First dataset sent: TimelineLabelBinaryPacket |
| 373 | VerifyTimelineLabelBinaryPacketData(EmptyOptional(), entityName, readableData, offset); |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 374 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 375 | // Second dataset sent: TimelineRelationshipBinaryPacket |
| 376 | VerifyTimelineRelationshipBinaryPacketData(ProfilingRelationshipType::LabelLink, |
| 377 | EmptyOptional(), |
| 378 | EmptyOptional(), |
| 379 | EmptyOptional(), |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 380 | LabelsAndEventClasses::NAME_GUID, |
| 381 | readableData, |
| 382 | offset); |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 383 | |
| 384 | // Packets for Type Entity |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 385 | // First dataset sent: TimelineLabelBinaryPacket |
| 386 | VerifyTimelineLabelBinaryPacketData(EmptyOptional(), entityType, readableData, offset); |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 387 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 388 | // Second dataset sent: TimelineRelationshipBinaryPacket |
| 389 | VerifyTimelineRelationshipBinaryPacketData(ProfilingRelationshipType::LabelLink, |
| 390 | EmptyOptional(), |
| 391 | EmptyOptional(), |
| 392 | EmptyOptional(), |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 393 | LabelsAndEventClasses::TYPE_GUID, |
| 394 | readableData, |
| 395 | offset); |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 396 | |
Finn Williams | 0a336dc | 2020-05-11 15:39:58 +0100 | [diff] [blame] | 397 | |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 398 | // Mark the buffer as read |
| 399 | mockBufferManager.MarkRead(readableBuffer); |
| 400 | } |
| 401 | |
Matteo Martincigh | 5dc816e | 2019-11-04 14:05:28 +0000 | [diff] [blame] | 402 | BOOST_AUTO_TEST_CASE(RecordEventTest) |
| 403 | { |
| 404 | MockBufferManager mockBufferManager(1024); |
Sadik Armagan | 3184c90 | 2020-03-18 10:57:30 +0000 | [diff] [blame] | 405 | ProfilingService profilingService; |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 406 | std::unique_ptr<ISendTimelinePacket> sendTimelinePacket = std::make_unique<SendTimelinePacket>(mockBufferManager); |
Sadik Armagan | 0a35667 | 2020-03-20 11:11:01 +0000 | [diff] [blame] | 407 | TimelineUtilityMethods timelineUtilityMethods(sendTimelinePacket); |
Narumol Prangnawarat | dbdd1b4 | 2019-11-15 17:38:44 +0000 | [diff] [blame] | 408 | // Generate first guid to ensure that the named typed entity guid is not 0 on local single test. |
Sadik Armagan | 3184c90 | 2020-03-18 10:57:30 +0000 | [diff] [blame] | 409 | profilingService.NextGuid(); |
Narumol Prangnawarat | dbdd1b4 | 2019-11-15 17:38:44 +0000 | [diff] [blame] | 410 | |
Matteo Martincigh | 5dc816e | 2019-11-04 14:05:28 +0000 | [diff] [blame] | 411 | ProfilingGuid entityGuid(123); |
| 412 | ProfilingStaticGuid eventClassGuid(456); |
| 413 | ProfilingDynamicGuid eventGuid(0); |
| 414 | BOOST_CHECK_NO_THROW(eventGuid = timelineUtilityMethods.RecordEvent(entityGuid, eventClassGuid)); |
| 415 | BOOST_CHECK(eventGuid != ProfilingGuid(0)); |
| 416 | |
| 417 | // Commit all packets at once |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 418 | timelineUtilityMethods.Commit(); |
Matteo Martincigh | 5dc816e | 2019-11-04 14:05:28 +0000 | [diff] [blame] | 419 | |
| 420 | // Get the readable buffer |
| 421 | auto readableBuffer = mockBufferManager.GetReadableBuffer(); |
| 422 | BOOST_CHECK(readableBuffer != nullptr); |
| 423 | unsigned int size = readableBuffer->GetSize(); |
Colm Donelan | 5bb3d8a | 2020-05-12 16:36:46 +0100 | [diff] [blame] | 424 | |
Finn Williams | 0a336dc | 2020-05-11 15:39:58 +0100 | [diff] [blame] | 425 | BOOST_CHECK(size == 68 + ThreadIdSize); |
Jan Eilers | a10e2a2 | 2020-03-26 12:04:54 +0000 | [diff] [blame] | 426 | |
Matteo Martincigh | 5dc816e | 2019-11-04 14:05:28 +0000 | [diff] [blame] | 427 | const unsigned char* readableData = readableBuffer->GetReadableData(); |
| 428 | BOOST_CHECK(readableData != nullptr); |
| 429 | |
| 430 | // Utils |
| 431 | unsigned int offset = 0; |
| 432 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 433 | // Verify Header |
Finn Williams | 0a336dc | 2020-05-11 15:39:58 +0100 | [diff] [blame] | 434 | VerifyTimelineHeaderBinary(readableData, offset, 60 + ThreadIdSize); |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 435 | |
| 436 | // First dataset sent: TimelineEntityBinaryPacket |
Matteo Martincigh | 5dc816e | 2019-11-04 14:05:28 +0000 | [diff] [blame] | 437 | VerifyTimelineEventBinaryPacket(EmptyOptional(), EmptyOptional(), EmptyOptional(), readableData, offset); |
| 438 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 439 | // Second dataset sent: TimelineRelationshipBinaryPacket |
| 440 | VerifyTimelineRelationshipBinaryPacketData(ProfilingRelationshipType::ExecutionLink, |
| 441 | EmptyOptional(), |
| 442 | entityGuid, |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 443 | eventGuid, |
| 444 | eventClassGuid, |
| 445 | readableData, |
| 446 | offset); |
Matteo Martincigh | 5dc816e | 2019-11-04 14:05:28 +0000 | [diff] [blame] | 447 | |
| 448 | // Mark the buffer as read |
| 449 | mockBufferManager.MarkRead(readableBuffer); |
| 450 | } |
| 451 | |
Matteo Martincigh | 830101c | 2019-10-22 11:07:45 +0100 | [diff] [blame] | 452 | BOOST_AUTO_TEST_SUITE_END() |