Matteo Martincigh | 830101c | 2019-10-22 11:07:45 +0100 | [diff] [blame] | 1 | // |
| 2 | // Copyright © 2019 Arm Ltd. All rights reserved. |
| 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(); |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 85 | BOOST_TEST(size == 300); |
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 |
| 93 | VerifyTimelineHeaderBinary(readableData, offset, 292); |
| 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 | |
| 119 | // Well-known types |
| 120 | // Layer |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 121 | VerifyTimelineLabelBinaryPacketData(LabelsAndEventClasses::LAYER_GUID, |
| 122 | LabelsAndEventClasses::LAYER, |
| 123 | readableData, |
| 124 | offset); |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 125 | |
| 126 | // Workload |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 127 | VerifyTimelineLabelBinaryPacketData(LabelsAndEventClasses::WORKLOAD_GUID, |
| 128 | LabelsAndEventClasses::WORKLOAD, |
| 129 | readableData, |
| 130 | offset); |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 131 | |
| 132 | // Network |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 133 | VerifyTimelineLabelBinaryPacketData(LabelsAndEventClasses::NETWORK_GUID, |
| 134 | LabelsAndEventClasses::NETWORK, |
| 135 | readableData, |
| 136 | offset); |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 137 | |
| 138 | // Connection |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 139 | VerifyTimelineLabelBinaryPacketData(LabelsAndEventClasses::CONNECTION_GUID, |
| 140 | LabelsAndEventClasses::CONNECTION, |
| 141 | readableData, |
| 142 | offset); |
| 143 | |
David Monahan | 6198fe0 | 2019-12-02 08:35:43 +0000 | [diff] [blame] | 144 | // Inference |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 145 | VerifyTimelineLabelBinaryPacketData(LabelsAndEventClasses::INFERENCE_GUID, |
| 146 | LabelsAndEventClasses::INFERENCE, |
| 147 | readableData, |
| 148 | offset); |
| 149 | |
David Monahan | 6198fe0 | 2019-12-02 08:35:43 +0000 | [diff] [blame] | 150 | // Workload Execution |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 151 | VerifyTimelineLabelBinaryPacketData(LabelsAndEventClasses::WORKLOAD_EXECUTION_GUID, |
| 152 | LabelsAndEventClasses::WORKLOAD_EXECUTION, |
| 153 | readableData, |
| 154 | offset); |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 155 | |
Matteo Martincigh | 102cdbd | 2019-10-28 11:42:50 +0000 | [diff] [blame] | 156 | // First "well-known" event class: START OF LIFE |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 157 | VerifyTimelineEventClassBinaryPacketData(LabelsAndEventClasses::ARMNN_PROFILING_SOL_EVENT_CLASS, |
| 158 | readableData, |
| 159 | offset); |
Matteo Martincigh | 102cdbd | 2019-10-28 11:42:50 +0000 | [diff] [blame] | 160 | |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 161 | // Second "well-known" event class: END OF LIFE |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 162 | VerifyTimelineEventClassBinaryPacketData(LabelsAndEventClasses::ARMNN_PROFILING_EOL_EVENT_CLASS, |
| 163 | readableData, |
| 164 | offset); |
Matteo Martincigh | 102cdbd | 2019-10-28 11:42:50 +0000 | [diff] [blame] | 165 | |
| 166 | // Mark the buffer as read |
| 167 | mockBufferManager.MarkRead(readableBuffer); |
| 168 | } |
| 169 | |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 170 | BOOST_AUTO_TEST_CASE(CreateNamedTypedChildEntityTest) |
| 171 | { |
| 172 | MockBufferManager mockBufferManager(1024); |
Sadik Armagan | 3184c90 | 2020-03-18 10:57:30 +0000 | [diff] [blame] | 173 | ProfilingService profilingService; |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 174 | std::unique_ptr<ISendTimelinePacket> sendTimelinePacket = std::make_unique<SendTimelinePacket>(mockBufferManager); |
Sadik Armagan | 0a35667 | 2020-03-20 11:11:01 +0000 | [diff] [blame] | 175 | TimelineUtilityMethods timelineUtilityMethods(sendTimelinePacket); |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 176 | |
Narumol Prangnawarat | 234d525 | 2019-11-19 15:49:18 +0000 | [diff] [blame] | 177 | ProfilingDynamicGuid childEntityGuid(0); |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 178 | ProfilingGuid parentEntityGuid(123); |
| 179 | const std::string entityName = "some entity"; |
| 180 | const std::string entityType = "some type"; |
| 181 | |
Narumol Prangnawarat | dbdd1b4 | 2019-11-15 17:38:44 +0000 | [diff] [blame] | 182 | // 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] | 183 | profilingService.NextGuid(); |
Narumol Prangnawarat | dbdd1b4 | 2019-11-15 17:38:44 +0000 | [diff] [blame] | 184 | |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 185 | BOOST_CHECK_THROW(timelineUtilityMethods.CreateNamedTypedChildEntity(parentEntityGuid, "", entityType), |
| 186 | InvalidArgumentException); |
| 187 | BOOST_CHECK_THROW(timelineUtilityMethods.CreateNamedTypedChildEntity(parentEntityGuid, entityName, ""), |
| 188 | InvalidArgumentException); |
Narumol Prangnawarat | 234d525 | 2019-11-19 15:49:18 +0000 | [diff] [blame] | 189 | BOOST_CHECK_THROW(timelineUtilityMethods.CreateNamedTypedChildEntity( |
| 190 | childEntityGuid, parentEntityGuid, "", entityType), InvalidArgumentException); |
| 191 | BOOST_CHECK_THROW(timelineUtilityMethods.CreateNamedTypedChildEntity( |
| 192 | childEntityGuid, parentEntityGuid, entityName, ""), InvalidArgumentException); |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 193 | |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 194 | BOOST_CHECK_NO_THROW(childEntityGuid = timelineUtilityMethods.CreateNamedTypedChildEntity(parentEntityGuid, |
| 195 | entityName, |
| 196 | entityType)); |
| 197 | BOOST_CHECK(childEntityGuid != ProfilingGuid(0)); |
| 198 | |
| 199 | // Commit all packets at once |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 200 | timelineUtilityMethods.Commit(); |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 201 | |
| 202 | // Get the readable buffer |
| 203 | auto readableBuffer = mockBufferManager.GetReadableBuffer(); |
| 204 | BOOST_CHECK(readableBuffer != nullptr); |
| 205 | unsigned int size = readableBuffer->GetSize(); |
Finn Williams | 0a336dc | 2020-05-11 15:39:58 +0100 | [diff] [blame] | 206 | BOOST_CHECK(size == 196); |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 207 | const unsigned char* readableData = readableBuffer->GetReadableData(); |
| 208 | BOOST_CHECK(readableData != nullptr); |
| 209 | |
| 210 | // Utils |
| 211 | unsigned int offset = 0; |
| 212 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 213 | // Verify Header |
Finn Williams | 0a336dc | 2020-05-11 15:39:58 +0100 | [diff] [blame] | 214 | VerifyTimelineHeaderBinary(readableData, offset, 188); |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 215 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 216 | // First dataset sent: TimelineEntityBinaryPacket |
| 217 | VerifyTimelineEntityBinaryPacketData(EmptyOptional(), readableData, offset); |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 218 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 219 | // Second dataset sent: TimelineLabelBinaryPacket |
| 220 | VerifyTimelineLabelBinaryPacketData(EmptyOptional(), entityName, readableData, offset); |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 221 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 222 | // Third dataset sent: TimelineRelationshipBinaryPacket |
| 223 | VerifyTimelineRelationshipBinaryPacketData(ProfilingRelationshipType::LabelLink, |
| 224 | EmptyOptional(), |
| 225 | EmptyOptional(), |
| 226 | EmptyOptional(), |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 227 | LabelsAndEventClasses::NAME_GUID, |
| 228 | readableData, |
| 229 | offset); |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 230 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 231 | // Fifth dataset sent: TimelineLabelBinaryPacket |
| 232 | VerifyTimelineLabelBinaryPacketData(EmptyOptional(), entityType, readableData, offset); |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 233 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 234 | // Sixth dataset sent: TimelineRelationshipBinaryPacket |
| 235 | VerifyTimelineRelationshipBinaryPacketData(ProfilingRelationshipType::LabelLink, |
| 236 | EmptyOptional(), |
| 237 | EmptyOptional(), |
| 238 | EmptyOptional(), |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 239 | LabelsAndEventClasses::TYPE_GUID, |
| 240 | readableData, |
| 241 | offset); |
| 242 | |
Finn Williams | 0a336dc | 2020-05-11 15:39:58 +0100 | [diff] [blame] | 243 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 244 | // Eighth dataset sent: TimelineRelationshipBinaryPacket |
| 245 | VerifyTimelineRelationshipBinaryPacketData(ProfilingRelationshipType::RetentionLink, |
| 246 | EmptyOptional(), |
| 247 | parentEntityGuid, |
| 248 | EmptyOptional(), |
Finn Williams | 0a336dc | 2020-05-11 15:39:58 +0100 | [diff] [blame] | 249 | EmptyOptional(), |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 250 | readableData, |
| 251 | offset); |
Narumol Prangnawarat | 94a3088 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 252 | |
| 253 | // Mark the buffer as read |
| 254 | mockBufferManager.MarkRead(readableBuffer); |
| 255 | } |
| 256 | |
Matteo Martincigh | 102cdbd | 2019-10-28 11:42:50 +0000 | [diff] [blame] | 257 | BOOST_AUTO_TEST_CASE(DeclareLabelTest) |
Matteo Martincigh | 830101c | 2019-10-22 11:07:45 +0100 | [diff] [blame] | 258 | { |
| 259 | MockBufferManager mockBufferManager(1024); |
Sadik Armagan | 3184c90 | 2020-03-18 10:57:30 +0000 | [diff] [blame] | 260 | ProfilingService profilingService; |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 261 | std::unique_ptr<ISendTimelinePacket> sendTimelinePacket = std::make_unique<SendTimelinePacket>(mockBufferManager); |
Sadik Armagan | 0a35667 | 2020-03-20 11:11:01 +0000 | [diff] [blame] | 262 | TimelineUtilityMethods timelineUtilityMethods(sendTimelinePacket); |
Matteo Martincigh | 830101c | 2019-10-22 11:07:45 +0100 | [diff] [blame] | 263 | |
Narumol Prangnawarat | dbdd1b4 | 2019-11-15 17:38:44 +0000 | [diff] [blame] | 264 | // 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] | 265 | profilingService.NextGuid(); |
Narumol Prangnawarat | dbdd1b4 | 2019-11-15 17:38:44 +0000 | [diff] [blame] | 266 | |
Matteo Martincigh | 830101c | 2019-10-22 11:07:45 +0100 | [diff] [blame] | 267 | // Try declaring an invalid (empty) label |
| 268 | BOOST_CHECK_THROW(timelineUtilityMethods.DeclareLabel(""), InvalidArgumentException); |
| 269 | |
| 270 | // Try declaring an invalid (wrong SWTrace format) label |
| 271 | BOOST_CHECK_THROW(timelineUtilityMethods.DeclareLabel("inv@lid lab€l"), RuntimeException); |
| 272 | |
| 273 | // Declare a valid label |
| 274 | const std::string labelName = "valid label"; |
| 275 | ProfilingGuid labelGuid = 0; |
| 276 | BOOST_CHECK_NO_THROW(labelGuid = timelineUtilityMethods.DeclareLabel(labelName)); |
Narumol Prangnawarat | dbdd1b4 | 2019-11-15 17:38:44 +0000 | [diff] [blame] | 277 | BOOST_CHECK(labelGuid != ProfilingGuid(0)); |
Matteo Martincigh | 830101c | 2019-10-22 11:07:45 +0100 | [diff] [blame] | 278 | |
Matteo Martincigh | 830101c | 2019-10-22 11:07:45 +0100 | [diff] [blame] | 279 | // Try adding the same label as before |
Narumol Prangnawarat | dbdd1b4 | 2019-11-15 17:38:44 +0000 | [diff] [blame] | 280 | ProfilingGuid newLabelGuid = 0; |
| 281 | BOOST_CHECK_NO_THROW(newLabelGuid = timelineUtilityMethods.DeclareLabel(labelName)); |
| 282 | BOOST_CHECK(newLabelGuid != ProfilingGuid(0)); |
| 283 | BOOST_CHECK(newLabelGuid == labelGuid); |
Matteo Martincigh | 830101c | 2019-10-22 11:07:45 +0100 | [diff] [blame] | 284 | } |
| 285 | |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 286 | BOOST_AUTO_TEST_CASE(CreateNameTypeEntityInvalidTest) |
| 287 | { |
| 288 | MockBufferManager mockBufferManager(1024); |
Sadik Armagan | 3184c90 | 2020-03-18 10:57:30 +0000 | [diff] [blame] | 289 | ProfilingService profilingService; |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 290 | std::unique_ptr<ISendTimelinePacket> sendTimelinePacket = std::make_unique<SendTimelinePacket>(mockBufferManager); |
Sadik Armagan | 0a35667 | 2020-03-20 11:11:01 +0000 | [diff] [blame] | 291 | TimelineUtilityMethods timelineUtilityMethods(sendTimelinePacket); |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 292 | |
| 293 | // Invalid name |
| 294 | BOOST_CHECK_THROW(timelineUtilityMethods.CreateNamedTypedEntity("", "Type"), InvalidArgumentException); |
| 295 | |
| 296 | // Invalid type |
| 297 | BOOST_CHECK_THROW(timelineUtilityMethods.CreateNamedTypedEntity("Name", ""), InvalidArgumentException); |
| 298 | |
Sadik Armagan | 3184c90 | 2020-03-18 10:57:30 +0000 | [diff] [blame] | 299 | ProfilingDynamicGuid guid = profilingService.NextGuid(); |
Narumol Prangnawarat | 234d525 | 2019-11-19 15:49:18 +0000 | [diff] [blame] | 300 | |
| 301 | // CreatedNamedTypedEntity with Guid - Invalid name |
| 302 | BOOST_CHECK_THROW(timelineUtilityMethods.CreateNamedTypedEntity(guid, "", "Type"), |
| 303 | InvalidArgumentException); |
| 304 | |
| 305 | // CreatedNamedTypedEntity with Guid - Invalid type |
| 306 | BOOST_CHECK_THROW(timelineUtilityMethods.CreateNamedTypedEntity(guid, "Name", ""), |
| 307 | InvalidArgumentException); |
| 308 | |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 309 | } |
| 310 | |
Matteo Martincigh | 5dc816e | 2019-11-04 14:05:28 +0000 | [diff] [blame] | 311 | BOOST_AUTO_TEST_CASE(CreateNameTypeEntityTest) |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 312 | { |
| 313 | MockBufferManager mockBufferManager(1024); |
Sadik Armagan | 3184c90 | 2020-03-18 10:57:30 +0000 | [diff] [blame] | 314 | ProfilingService profilingService; |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 315 | std::unique_ptr<ISendTimelinePacket> sendTimelinePacket = std::make_unique<SendTimelinePacket>(mockBufferManager); |
Sadik Armagan | 0a35667 | 2020-03-20 11:11:01 +0000 | [diff] [blame] | 316 | TimelineUtilityMethods timelineUtilityMethods(sendTimelinePacket); |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 317 | |
| 318 | const std::string entityName = "Entity0"; |
| 319 | const std::string entityType = "Type0"; |
| 320 | |
Narumol Prangnawarat | dbdd1b4 | 2019-11-15 17:38:44 +0000 | [diff] [blame] | 321 | // 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] | 322 | profilingService.NextGuid(); |
Narumol Prangnawarat | dbdd1b4 | 2019-11-15 17:38:44 +0000 | [diff] [blame] | 323 | |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 324 | ProfilingDynamicGuid guid = timelineUtilityMethods.CreateNamedTypedEntity(entityName, entityType); |
| 325 | BOOST_CHECK(guid != ProfilingGuid(0)); |
| 326 | |
| 327 | // Commit all packets at once |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 328 | timelineUtilityMethods.Commit(); |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 329 | |
| 330 | // Get the readable buffer |
| 331 | auto readableBuffer = mockBufferManager.GetReadableBuffer(); |
| 332 | BOOST_CHECK(readableBuffer != nullptr); |
| 333 | unsigned int size = readableBuffer->GetSize(); |
Finn Williams | 0a336dc | 2020-05-11 15:39:58 +0100 | [diff] [blame] | 334 | BOOST_CHECK(size == 148); |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 335 | const unsigned char* readableData = readableBuffer->GetReadableData(); |
| 336 | BOOST_CHECK(readableData != nullptr); |
| 337 | |
| 338 | // Utils |
| 339 | unsigned int offset = 0; |
| 340 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 341 | // Verify Header |
Finn Williams | 0a336dc | 2020-05-11 15:39:58 +0100 | [diff] [blame] | 342 | VerifyTimelineHeaderBinary(readableData, offset, 140); |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 343 | |
| 344 | // First dataset sent: TimelineEntityBinaryPacket |
| 345 | VerifyTimelineEntityBinaryPacketData(guid, readableData, offset); |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 346 | |
| 347 | // Packets for Name Entity |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 348 | // First dataset sent: TimelineLabelBinaryPacket |
| 349 | VerifyTimelineLabelBinaryPacketData(EmptyOptional(), entityName, readableData, offset); |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 350 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 351 | // Second dataset sent: TimelineRelationshipBinaryPacket |
| 352 | VerifyTimelineRelationshipBinaryPacketData(ProfilingRelationshipType::LabelLink, |
| 353 | EmptyOptional(), |
| 354 | EmptyOptional(), |
| 355 | EmptyOptional(), |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 356 | LabelsAndEventClasses::NAME_GUID, |
| 357 | readableData, |
| 358 | offset); |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 359 | |
| 360 | // Packets for Type Entity |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 361 | // First dataset sent: TimelineLabelBinaryPacket |
| 362 | VerifyTimelineLabelBinaryPacketData(EmptyOptional(), entityType, readableData, offset); |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 363 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 364 | // Second dataset sent: TimelineRelationshipBinaryPacket |
| 365 | VerifyTimelineRelationshipBinaryPacketData(ProfilingRelationshipType::LabelLink, |
| 366 | EmptyOptional(), |
| 367 | EmptyOptional(), |
| 368 | EmptyOptional(), |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 369 | LabelsAndEventClasses::TYPE_GUID, |
| 370 | readableData, |
| 371 | offset); |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 372 | |
Finn Williams | 0a336dc | 2020-05-11 15:39:58 +0100 | [diff] [blame] | 373 | |
Narumol Prangnawarat | d034e08 | 2019-10-30 12:48:31 +0000 | [diff] [blame] | 374 | // Mark the buffer as read |
| 375 | mockBufferManager.MarkRead(readableBuffer); |
| 376 | } |
| 377 | |
Matteo Martincigh | 5dc816e | 2019-11-04 14:05:28 +0000 | [diff] [blame] | 378 | BOOST_AUTO_TEST_CASE(RecordEventTest) |
| 379 | { |
| 380 | MockBufferManager mockBufferManager(1024); |
Sadik Armagan | 3184c90 | 2020-03-18 10:57:30 +0000 | [diff] [blame] | 381 | ProfilingService profilingService; |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 382 | std::unique_ptr<ISendTimelinePacket> sendTimelinePacket = std::make_unique<SendTimelinePacket>(mockBufferManager); |
Sadik Armagan | 0a35667 | 2020-03-20 11:11:01 +0000 | [diff] [blame] | 383 | TimelineUtilityMethods timelineUtilityMethods(sendTimelinePacket); |
Narumol Prangnawarat | dbdd1b4 | 2019-11-15 17:38:44 +0000 | [diff] [blame] | 384 | // 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] | 385 | profilingService.NextGuid(); |
Narumol Prangnawarat | dbdd1b4 | 2019-11-15 17:38:44 +0000 | [diff] [blame] | 386 | |
Matteo Martincigh | 5dc816e | 2019-11-04 14:05:28 +0000 | [diff] [blame] | 387 | ProfilingGuid entityGuid(123); |
| 388 | ProfilingStaticGuid eventClassGuid(456); |
| 389 | ProfilingDynamicGuid eventGuid(0); |
| 390 | BOOST_CHECK_NO_THROW(eventGuid = timelineUtilityMethods.RecordEvent(entityGuid, eventClassGuid)); |
| 391 | BOOST_CHECK(eventGuid != ProfilingGuid(0)); |
| 392 | |
| 393 | // Commit all packets at once |
Narumol Prangnawarat | df31cfe | 2019-11-22 11:26:06 +0000 | [diff] [blame] | 394 | timelineUtilityMethods.Commit(); |
Matteo Martincigh | 5dc816e | 2019-11-04 14:05:28 +0000 | [diff] [blame] | 395 | |
| 396 | // Get the readable buffer |
| 397 | auto readableBuffer = mockBufferManager.GetReadableBuffer(); |
| 398 | BOOST_CHECK(readableBuffer != nullptr); |
| 399 | unsigned int size = readableBuffer->GetSize(); |
Colm Donelan | 5bb3d8a | 2020-05-12 16:36:46 +0100 | [diff] [blame] | 400 | |
Finn Williams | 0a336dc | 2020-05-11 15:39:58 +0100 | [diff] [blame] | 401 | BOOST_CHECK(size == 68 + ThreadIdSize); |
Jan Eilers | a10e2a2 | 2020-03-26 12:04:54 +0000 | [diff] [blame] | 402 | |
Matteo Martincigh | 5dc816e | 2019-11-04 14:05:28 +0000 | [diff] [blame] | 403 | const unsigned char* readableData = readableBuffer->GetReadableData(); |
| 404 | BOOST_CHECK(readableData != nullptr); |
| 405 | |
| 406 | // Utils |
| 407 | unsigned int offset = 0; |
| 408 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 409 | // Verify Header |
Finn Williams | 0a336dc | 2020-05-11 15:39:58 +0100 | [diff] [blame] | 410 | VerifyTimelineHeaderBinary(readableData, offset, 60 + ThreadIdSize); |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 411 | |
| 412 | // First dataset sent: TimelineEntityBinaryPacket |
Matteo Martincigh | 5dc816e | 2019-11-04 14:05:28 +0000 | [diff] [blame] | 413 | VerifyTimelineEventBinaryPacket(EmptyOptional(), EmptyOptional(), EmptyOptional(), readableData, offset); |
| 414 | |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 415 | // Second dataset sent: TimelineRelationshipBinaryPacket |
| 416 | VerifyTimelineRelationshipBinaryPacketData(ProfilingRelationshipType::ExecutionLink, |
| 417 | EmptyOptional(), |
| 418 | entityGuid, |
Keith Davis | 97da5e2 | 2020-03-05 16:25:28 +0000 | [diff] [blame] | 419 | eventGuid, |
| 420 | eventClassGuid, |
| 421 | readableData, |
| 422 | offset); |
Matteo Martincigh | 5dc816e | 2019-11-04 14:05:28 +0000 | [diff] [blame] | 423 | |
| 424 | // Mark the buffer as read |
| 425 | mockBufferManager.MarkRead(readableBuffer); |
| 426 | } |
| 427 | |
Matteo Martincigh | 830101c | 2019-10-22 11:07:45 +0100 | [diff] [blame] | 428 | BOOST_AUTO_TEST_SUITE_END() |