Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 1 | // |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 2 | // Copyright © 2019 Arm Ltd and Contributors. All rights reserved. |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 3 | // SPDX-License-Identifier: MIT |
| 4 | // |
| 5 | |
| 6 | #include "../ProfilingConnectionDumpToFileDecorator.hpp" |
Rob Hughes | 9542f90 | 2021-07-14 09:48:54 +0100 | [diff] [blame] | 7 | #include <armnnUtils/Filesystem.hpp> |
Keith Davis | b10e081 | 2019-10-17 09:52:50 +0100 | [diff] [blame] | 8 | #include <Runtime.hpp> |
Jan Eilers | 8eb2560 | 2020-03-09 12:13:48 +0000 | [diff] [blame] | 9 | #include <armnn/utility/IgnoreUnused.hpp> |
Matthew Sloyan | 371b70e | 2020-09-11 10:14:57 +0100 | [diff] [blame] | 10 | #include <armnn/utility/NumericCast.hpp> |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 11 | |
| 12 | #include <fstream> |
| 13 | #include <sstream> |
| 14 | |
Sadik Armagan | 1625efc | 2021-06-10 18:24:34 +0100 | [diff] [blame] | 15 | #include <doctest/doctest.h> |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 16 | |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 17 | using namespace armnn::profiling; |
| 18 | |
| 19 | namespace |
| 20 | { |
| 21 | |
| 22 | const std::vector<char> g_Data = { 'd', 'u', 'm', 'm', 'y' }; |
Matthew Sloyan | 371b70e | 2020-09-11 10:14:57 +0100 | [diff] [blame] | 23 | const uint32_t g_DataLength = armnn::numeric_cast<uint32_t>(g_Data.size()); |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 24 | const unsigned char* g_DataPtr = reinterpret_cast<const unsigned char*>(g_Data.data()); |
| 25 | |
| 26 | class DummyProfilingConnection : public IProfilingConnection |
| 27 | { |
| 28 | public: |
| 29 | DummyProfilingConnection() |
| 30 | : m_Open(true) |
Matteo Martincigh | 67ef2a5 | 2019-10-10 13:29:02 +0100 | [diff] [blame] | 31 | , m_PacketData(std::make_unique<unsigned char[]>(g_DataLength)) |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 32 | { |
| 33 | // populate packet data and construct packet |
| 34 | std::memcpy(m_PacketData.get(), g_DataPtr, g_DataLength); |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 35 | m_Packet = std::make_unique<arm::pipe::Packet>(0u, g_DataLength, m_PacketData); |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 36 | } |
| 37 | |
| 38 | ~DummyProfilingConnection() = default; |
| 39 | |
Matteo Martincigh | 54fb957 | 2019-10-02 12:50:57 +0100 | [diff] [blame] | 40 | bool IsOpen() const override |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 41 | { |
| 42 | return m_Open; |
| 43 | } |
| 44 | |
| 45 | void Close() override |
| 46 | { |
| 47 | m_Open = false; |
| 48 | } |
| 49 | |
| 50 | bool WritePacket(const unsigned char* buffer, uint32_t length) override |
| 51 | { |
Jan Eilers | 8eb2560 | 2020-03-09 12:13:48 +0000 | [diff] [blame] | 52 | armnn::IgnoreUnused(buffer); |
| 53 | armnn::IgnoreUnused(length); |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 54 | return true; |
| 55 | } |
| 56 | |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 57 | arm::pipe::Packet ReadPacket(uint32_t timeout) override |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 58 | { |
Jan Eilers | 8eb2560 | 2020-03-09 12:13:48 +0000 | [diff] [blame] | 59 | armnn::IgnoreUnused(timeout); |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 60 | return std::move(*m_Packet); |
| 61 | } |
| 62 | |
| 63 | private: |
Matteo Martincigh | 67ef2a5 | 2019-10-10 13:29:02 +0100 | [diff] [blame] | 64 | bool m_Open; |
| 65 | std::unique_ptr<unsigned char[]> m_PacketData; |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 66 | std::unique_ptr<arm::pipe::Packet> m_Packet; |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 67 | }; |
| 68 | |
| 69 | std::vector<char> ReadDumpFile(const std::string& dumpFileName) |
| 70 | { |
| 71 | std::ifstream input(dumpFileName, std::ios::binary); |
| 72 | return std::vector<char>(std::istreambuf_iterator<char>(input), {}); |
| 73 | } |
| 74 | |
| 75 | } // anonymous namespace |
| 76 | |
Sadik Armagan | 1625efc | 2021-06-10 18:24:34 +0100 | [diff] [blame] | 77 | TEST_SUITE("ProfilingConnectionDumpToFileDecoratorTests") |
| 78 | { |
| 79 | TEST_CASE("DumpIncomingInvalidFile") |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 80 | { |
Kevin May | d92a6e4 | 2021-02-04 10:27:41 +0000 | [diff] [blame] | 81 | armnn::IRuntime::CreationOptions::ExternalProfilingOptions options; |
Keith Davis | b10e081 | 2019-10-17 09:52:50 +0100 | [diff] [blame] | 82 | options.m_IncomingCaptureFile = "/"; |
| 83 | options.m_OutgoingCaptureFile = ""; |
| 84 | ProfilingConnectionDumpToFileDecorator decorator(std::make_unique<DummyProfilingConnection>(), options, false); |
Sadik Armagan | 1625efc | 2021-06-10 18:24:34 +0100 | [diff] [blame] | 85 | CHECK_THROWS_AS(decorator.ReadPacket(0), armnn::RuntimeException); |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 86 | } |
| 87 | |
Sadik Armagan | 1625efc | 2021-06-10 18:24:34 +0100 | [diff] [blame] | 88 | TEST_CASE("DumpIncomingInvalidFileIgnoreErrors") |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 89 | { |
Kevin May | d92a6e4 | 2021-02-04 10:27:41 +0000 | [diff] [blame] | 90 | armnn::IRuntime::CreationOptions::ExternalProfilingOptions options; |
Keith Davis | b10e081 | 2019-10-17 09:52:50 +0100 | [diff] [blame] | 91 | options.m_IncomingCaptureFile = "/"; |
| 92 | options.m_OutgoingCaptureFile = ""; |
| 93 | ProfilingConnectionDumpToFileDecorator decorator(std::make_unique<DummyProfilingConnection>(), options, true); |
Sadik Armagan | 1625efc | 2021-06-10 18:24:34 +0100 | [diff] [blame] | 94 | CHECK_NOTHROW(decorator.ReadPacket(0)); |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 95 | } |
| 96 | |
Sadik Armagan | 1625efc | 2021-06-10 18:24:34 +0100 | [diff] [blame] | 97 | TEST_CASE("DumpIncomingValidFile") |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 98 | { |
Francis Murtagh | 532a29d | 2020-06-29 11:50:01 +0100 | [diff] [blame] | 99 | fs::path fileName = armnnUtils::Filesystem::NamedTempFile("Armnn-DumpIncomingValidFileTest-TempFile"); |
Aron Virginas-Tar | 8bf442e | 2019-11-07 18:41:40 +0000 | [diff] [blame] | 100 | |
Kevin May | d92a6e4 | 2021-02-04 10:27:41 +0000 | [diff] [blame] | 101 | armnn::IRuntime::CreationOptions::ExternalProfilingOptions options; |
Rob Hughes | 270233f | 2019-11-13 11:53:48 +0000 | [diff] [blame] | 102 | options.m_IncomingCaptureFile = fileName.string(); |
Keith Davis | b10e081 | 2019-10-17 09:52:50 +0100 | [diff] [blame] | 103 | options.m_OutgoingCaptureFile = ""; |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 104 | |
Keith Davis | b10e081 | 2019-10-17 09:52:50 +0100 | [diff] [blame] | 105 | ProfilingConnectionDumpToFileDecorator decorator(std::make_unique<DummyProfilingConnection>(), options, false); |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 106 | |
| 107 | // NOTE: unique_ptr is needed here because operator=() is deleted for Packet |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 108 | std::unique_ptr<arm::pipe::Packet> packet; |
Sadik Armagan | 1625efc | 2021-06-10 18:24:34 +0100 | [diff] [blame] | 109 | CHECK_NOTHROW(packet = std::make_unique<arm::pipe::Packet>(decorator.ReadPacket(0))); |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 110 | |
| 111 | decorator.Close(); |
| 112 | |
Keith Davis | b10e081 | 2019-10-17 09:52:50 +0100 | [diff] [blame] | 113 | std::vector<char> data = ReadDumpFile(options.m_IncomingCaptureFile); |
Matteo Martincigh | 67ef2a5 | 2019-10-10 13:29:02 +0100 | [diff] [blame] | 114 | const char* packetData = reinterpret_cast<const char*>(packet->GetData()); |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 115 | |
| 116 | // check if the data read back from the dump file matches the original |
| 117 | constexpr unsigned int bytesToSkip = 2u * sizeof(uint32_t); // skip header and packet length |
| 118 | int diff = std::strncmp(data.data() + bytesToSkip, packetData, g_DataLength); |
Sadik Armagan | 1625efc | 2021-06-10 18:24:34 +0100 | [diff] [blame] | 119 | CHECK(diff == 0); |
Francis Murtagh | 532a29d | 2020-06-29 11:50:01 +0100 | [diff] [blame] | 120 | fs::remove(fileName); |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 121 | } |
| 122 | |
Sadik Armagan | 1625efc | 2021-06-10 18:24:34 +0100 | [diff] [blame] | 123 | TEST_CASE("DumpOutgoingInvalidFile") |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 124 | { |
Kevin May | d92a6e4 | 2021-02-04 10:27:41 +0000 | [diff] [blame] | 125 | armnn::IRuntime::CreationOptions::ExternalProfilingOptions options; |
Keith Davis | b10e081 | 2019-10-17 09:52:50 +0100 | [diff] [blame] | 126 | options.m_IncomingCaptureFile = ""; |
| 127 | options.m_OutgoingCaptureFile = "/"; |
| 128 | ProfilingConnectionDumpToFileDecorator decorator(std::make_unique<DummyProfilingConnection>(), options, false); |
Sadik Armagan | 1625efc | 2021-06-10 18:24:34 +0100 | [diff] [blame] | 129 | CHECK_THROWS_AS(decorator.WritePacket(g_DataPtr, g_DataLength), armnn::RuntimeException); |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 130 | } |
| 131 | |
Sadik Armagan | 1625efc | 2021-06-10 18:24:34 +0100 | [diff] [blame] | 132 | TEST_CASE("DumpOutgoingInvalidFileIgnoreErrors") |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 133 | { |
Kevin May | d92a6e4 | 2021-02-04 10:27:41 +0000 | [diff] [blame] | 134 | armnn::IRuntime::CreationOptions::ExternalProfilingOptions options; |
Keith Davis | b10e081 | 2019-10-17 09:52:50 +0100 | [diff] [blame] | 135 | options.m_IncomingCaptureFile = ""; |
| 136 | options.m_OutgoingCaptureFile = "/"; |
| 137 | |
| 138 | ProfilingConnectionDumpToFileDecorator decorator(std::make_unique<DummyProfilingConnection>(), options, true); |
Sadik Armagan | 1625efc | 2021-06-10 18:24:34 +0100 | [diff] [blame] | 139 | CHECK_NOTHROW(decorator.WritePacket(g_DataPtr, g_DataLength)); |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 140 | |
| 141 | bool success = decorator.WritePacket(g_DataPtr, g_DataLength); |
Sadik Armagan | 1625efc | 2021-06-10 18:24:34 +0100 | [diff] [blame] | 142 | CHECK(!success); |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 143 | } |
| 144 | |
Sadik Armagan | 1625efc | 2021-06-10 18:24:34 +0100 | [diff] [blame] | 145 | TEST_CASE("DumpOutgoingValidFile") |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 146 | { |
Francis Murtagh | 532a29d | 2020-06-29 11:50:01 +0100 | [diff] [blame] | 147 | fs::path fileName = armnnUtils::Filesystem::NamedTempFile("Armnn-DumpOutgoingValidFileTest-TempFile"); |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 148 | |
Kevin May | d92a6e4 | 2021-02-04 10:27:41 +0000 | [diff] [blame] | 149 | armnn::IRuntime::CreationOptions::ExternalProfilingOptions options; |
Keith Davis | b10e081 | 2019-10-17 09:52:50 +0100 | [diff] [blame] | 150 | options.m_IncomingCaptureFile = ""; |
Rob Hughes | 270233f | 2019-11-13 11:53:48 +0000 | [diff] [blame] | 151 | options.m_OutgoingCaptureFile = fileName.string(); |
Keith Davis | b10e081 | 2019-10-17 09:52:50 +0100 | [diff] [blame] | 152 | |
| 153 | ProfilingConnectionDumpToFileDecorator decorator(std::make_unique<DummyProfilingConnection>(), options, false); |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 154 | |
| 155 | bool success = false; |
Sadik Armagan | 1625efc | 2021-06-10 18:24:34 +0100 | [diff] [blame] | 156 | CHECK_NOTHROW(success = decorator.WritePacket(g_DataPtr, g_DataLength)); |
| 157 | CHECK(success); |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 158 | |
| 159 | decorator.Close(); |
| 160 | |
Keith Davis | b10e081 | 2019-10-17 09:52:50 +0100 | [diff] [blame] | 161 | std::vector<char> data = ReadDumpFile(options.m_OutgoingCaptureFile); |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 162 | |
| 163 | // check if the data read back from the dump file matches the original |
| 164 | int diff = std::strncmp(data.data(), g_Data.data(), g_DataLength); |
Sadik Armagan | 1625efc | 2021-06-10 18:24:34 +0100 | [diff] [blame] | 165 | CHECK(diff == 0); |
Francis Murtagh | 532a29d | 2020-06-29 11:50:01 +0100 | [diff] [blame] | 166 | fs::remove(fileName); |
Aron Virginas-Tar | dfa1477 | 2019-09-24 18:24:47 +0100 | [diff] [blame] | 167 | } |
| 168 | |
Sadik Armagan | 1625efc | 2021-06-10 18:24:34 +0100 | [diff] [blame] | 169 | } |