| // |
| // Copyright © 2017 Arm Ltd. All rights reserved. |
| // SPDX-License-Identifier: MIT |
| // |
| |
| #include <armnn/IRuntime.hpp> |
| #include <armnn/TypesUtils.hpp> |
| #include <armnn/utility/IgnoreUnused.hpp> |
| |
| #include <boost/test/unit_test.hpp> |
| #include <boost/test/tools/output_test_stream.hpp> |
| #include <boost/algorithm/string.hpp> |
| |
| #include <memory> |
| #include <thread> |
| #include <ostream> |
| |
| #include <Profiling.hpp> |
| |
| namespace armnn |
| { |
| |
| size_t GetProfilerEventSequenceSize(armnn::Profiler* profiler) |
| { |
| if (!profiler) |
| { |
| return static_cast<size_t>(-1); |
| } |
| |
| return profiler->m_EventSequence.size(); |
| } |
| } // namespace armnn |
| |
| namespace |
| { |
| |
| void RegisterUnregisterProfilerSingleThreadImpl(bool &res) |
| { |
| // Important! Don't use BOOST_TEST macros in this function as they |
| // seem to have problems when used in threads |
| |
| // Get a reference to the profiler manager. |
| armnn::ProfilerManager& profilerManager = armnn::ProfilerManager::GetInstance(); |
| |
| // Check that there's no profiler registered for this thread. |
| res = !profilerManager.GetProfiler(); |
| |
| // Create and register a profiler for this thread. |
| std::unique_ptr<armnn::Profiler> profiler = std::make_unique<armnn::Profiler>(); |
| profilerManager.RegisterProfiler(profiler.get()); |
| |
| // Check that on a single thread we get the same profiler we registered. |
| res &= profiler.get() == profilerManager.GetProfiler(); |
| |
| // Destroy the profiler. |
| profiler.reset(); |
| |
| // Check that the profiler has been un-registered for this thread. |
| res &= !profilerManager.GetProfiler(); |
| |
| armnn::ProfilerManager::GetInstance().RegisterProfiler(nullptr); |
| } |
| |
| } // namespace |
| |
| BOOST_AUTO_TEST_SUITE(Profiler) |
| |
| BOOST_AUTO_TEST_CASE(EnableDisableProfiling) |
| { |
| std::unique_ptr<armnn::Profiler> profiler = std::make_unique<armnn::Profiler>(); |
| |
| // Check that profiling is disabled by default. |
| BOOST_TEST(!profiler->IsProfilingEnabled()); |
| |
| // Enable profiling. |
| profiler->EnableProfiling(true); |
| |
| // Check that profiling is enabled. |
| BOOST_TEST(profiler->IsProfilingEnabled()); |
| |
| // Disable profiling. |
| profiler->EnableProfiling(false); |
| |
| // Check that profiling is disabled. |
| BOOST_TEST(!profiler->IsProfilingEnabled()); |
| } |
| |
| BOOST_AUTO_TEST_CASE(RegisterUnregisterProfilerSingleThread) |
| { |
| bool res = false; |
| RegisterUnregisterProfilerSingleThreadImpl(res); |
| BOOST_TEST(res); |
| } |
| |
| BOOST_AUTO_TEST_CASE(RegisterUnregisterProfilerMultipleThreads) |
| { |
| bool res[3] = {false, false, false}; |
| std::thread thread1([&res]() { RegisterUnregisterProfilerSingleThreadImpl(res[0]); }); |
| std::thread thread2([&res]() { RegisterUnregisterProfilerSingleThreadImpl(res[1]); }); |
| std::thread thread3([&res]() { RegisterUnregisterProfilerSingleThreadImpl(res[2]); }); |
| |
| thread1.join(); |
| thread2.join(); |
| thread3.join(); |
| |
| for (int i = 0 ; i < 3 ; i++) |
| { |
| BOOST_TEST(res[i]); |
| } |
| } |
| |
| BOOST_AUTO_TEST_CASE(ProfilingMacros) |
| { |
| // Get a reference to the profiler manager. |
| armnn::ProfilerManager& profilerManager = armnn::ProfilerManager::GetInstance(); |
| |
| { // --- No profiler --- |
| |
| // Check that there's no profiler registered for this thread. |
| BOOST_TEST(!profilerManager.GetProfiler()); |
| |
| // Test scoped event. |
| { ARMNN_SCOPED_PROFILING_EVENT(armnn::Compute::CpuAcc, "test"); } |
| |
| // Check that we still cannot get a profiler for this thread. |
| BOOST_TEST(!profilerManager.GetProfiler()); |
| } |
| |
| // Create and register a profiler for this thread. |
| std::unique_ptr<armnn::Profiler> profiler = std::make_unique<armnn::Profiler>(); |
| profilerManager.RegisterProfiler(profiler.get()); |
| |
| { // --- Profiler, but profiling disabled --- |
| |
| // Get current event sequence size. |
| size_t eventSequenceSizeBefore = armnn::GetProfilerEventSequenceSize(profiler.get()); |
| |
| // Test scoped macro. |
| { ARMNN_SCOPED_PROFILING_EVENT(armnn::Compute::CpuAcc, "test"); } |
| |
| // Check that no profiling event has been added to the sequence. |
| size_t eventSequenceSizeAfter = armnn::GetProfilerEventSequenceSize(profiler.get()); |
| BOOST_TEST(eventSequenceSizeBefore == eventSequenceSizeAfter); |
| } |
| |
| // Enable profiling. |
| profiler->EnableProfiling(true); |
| |
| { // --- Profiler, and profiling enabled --- |
| |
| // Get current event sequence size. |
| size_t eventSequenceSizeBefore = armnn::GetProfilerEventSequenceSize(profiler.get()); |
| |
| // Test scoped macro. |
| { ARMNN_SCOPED_PROFILING_EVENT(armnn::Compute::CpuAcc, "test"); } |
| |
| // Check that a profiling event has been added to the sequence. |
| size_t eventSequenceSizeAfter = armnn::GetProfilerEventSequenceSize(profiler.get()); |
| BOOST_TEST(eventSequenceSizeAfter == eventSequenceSizeBefore + 1); |
| } |
| |
| // Disable profiling here to not print out anything on stdout. |
| profiler->EnableProfiling(false); |
| } |
| |
| #if defined(ARMNNREF_ENABLED) |
| |
| // This test unit needs the reference backend, it's not available if the reference backend is not built |
| |
| BOOST_AUTO_TEST_CASE(RuntimeLoadNetwork) |
| { |
| // Get a reference to the profiler manager. |
| armnn::ProfilerManager& profilerManager = armnn::ProfilerManager::GetInstance(); |
| |
| // Check that there's no profiler registered for this thread. |
| BOOST_TEST(!profilerManager.GetProfiler()); |
| |
| // Build a mock-network and load it into the runtime. |
| armnn::IRuntime::CreationOptions options; |
| armnn::IRuntimePtr runtime(armnn::IRuntime::Create(options)); |
| armnn::NetworkId networkIdentifier = 1; |
| armnn::INetworkPtr mockNetwork(armnn::INetwork::Create()); |
| mockNetwork->AddInputLayer(0, "test layer"); |
| std::vector<armnn::BackendId> backends = { armnn::Compute::CpuRef }; |
| runtime->LoadNetwork(networkIdentifier, armnn::Optimize(*mockNetwork, backends, runtime->GetDeviceSpec())); |
| |
| // Check that now there's a profiler registered for this thread (created and registered by the loading the network). |
| BOOST_TEST(profilerManager.GetProfiler()); |
| |
| // Unload the network. |
| runtime->UnloadNetwork(networkIdentifier); |
| |
| // Check that the profiler has been un-registered for this thread. |
| BOOST_TEST(!profilerManager.GetProfiler()); |
| } |
| |
| #endif |
| |
| BOOST_AUTO_TEST_CASE(WriteEventResults) |
| { |
| // Get a reference to the profiler manager. |
| armnn::ProfilerManager& profileManager = armnn::ProfilerManager::GetInstance(); |
| |
| // Create and register a profiler for this thread. |
| std::unique_ptr<armnn::Profiler> profiler = std::make_unique<armnn::Profiler>(); |
| profileManager.RegisterProfiler(profiler.get()); |
| |
| // Enable profiling. |
| profiler->EnableProfiling(true); |
| |
| { // --- Profiler, and profiling enabled --- |
| |
| // Get current event sequence size. |
| size_t eventSequenceSizeBefore = armnn::GetProfilerEventSequenceSize(profiler.get()); |
| |
| // Test scoped macro. |
| { |
| // Need to directly create a ScopedProfilingEvent as the one created by the macro falls out of scope |
| // immediately causing the Event.Stop() function method to be called immediately after the Event.Start() |
| // function resulting in periodic test failures on the Dent and Smith HiKeys |
| armnn::ScopedProfilingEvent testEvent(armnn::Compute::CpuAcc, "test", armnn::WallClockTimer()); |
| std::this_thread::sleep_for(std::chrono::milliseconds(10)); |
| } |
| |
| // Check that a profiling event has been added to the sequence. |
| size_t eventSequenceSizeAfter = armnn::GetProfilerEventSequenceSize(profiler.get()); |
| BOOST_TEST(eventSequenceSizeAfter == eventSequenceSizeBefore + 1); |
| |
| boost::test_tools::output_test_stream output; |
| profiler->AnalyzeEventsAndWriteResults(output); |
| BOOST_TEST(!output.is_empty(false)); |
| |
| // output should contain event name 'test' |
| BOOST_CHECK(boost::contains(output.str(), "test")); |
| |
| // output should contain headers |
| BOOST_CHECK(boost::contains(output.str(), "Event Sequence - Name")); |
| BOOST_CHECK(boost::contains(output.str(), "Event Stats - Name")); |
| BOOST_CHECK(boost::contains(output.str(), "Total")); |
| BOOST_CHECK(boost::contains(output.str(), "Device")); |
| // output should contain compute device 'CpuAcc' |
| BOOST_CHECK(boost::contains(output.str(), "CpuAcc")); |
| // output should not contain un-readable numbers |
| BOOST_CHECK(!(boost::contains(output.str(), "e+"))); |
| // output should not contain un-readable numbers |
| BOOST_CHECK(!(boost::contains(output.str(), "+"))); |
| // output should not contain zero value |
| BOOST_CHECK(!(boost::contains(output.str(), " 0 "))); |
| } |
| |
| // Disable profiling here to not print out anything on stdout. |
| profiler->EnableProfiling(false); |
| } |
| |
| BOOST_AUTO_TEST_CASE(ProfilerJsonPrinter) |
| { |
| class TestInstrument : public armnn::Instrument |
| { |
| public: |
| virtual ~TestInstrument() {} |
| void Start() override {} |
| void Stop() override {} |
| |
| std::vector<armnn::Measurement> GetMeasurements() const override |
| { |
| std::vector<armnn::Measurement> measurements; |
| measurements.emplace_back(armnn::Measurement("Measurement1", |
| 1.0, |
| armnn::Measurement::Unit::TIME_MS)); |
| measurements.emplace_back(armnn::Measurement("Measurement2", |
| 2.0, |
| armnn::Measurement::Unit::TIME_US)); |
| return measurements; |
| } |
| |
| const char* GetName() const override |
| { |
| return "TestInstrument"; |
| } |
| }; |
| |
| // Get a reference to the profiler manager. |
| armnn::ProfilerManager& profilerManager = armnn::ProfilerManager::GetInstance(); |
| |
| // Create and register a profiler for this thread. |
| std::unique_ptr<armnn::Profiler> profiler = std::make_unique<armnn::Profiler>(); |
| profilerManager.RegisterProfiler(profiler.get()); |
| |
| profiler->EnableProfiling(true); |
| |
| { |
| // Test scoped macro. |
| ARMNN_SCOPED_PROFILING_EVENT_WITH_INSTRUMENTS(armnn::Compute::CpuAcc, "EnqueueWorkload", TestInstrument()) |
| ARMNN_SCOPED_PROFILING_EVENT_WITH_INSTRUMENTS(armnn::Compute::CpuAcc, "Level 0", TestInstrument()) |
| { |
| { |
| ARMNN_SCOPED_PROFILING_EVENT_WITH_INSTRUMENTS(armnn::Compute::CpuAcc, "Level 1A", TestInstrument()) |
| } |
| |
| { |
| ARMNN_SCOPED_PROFILING_EVENT_WITH_INSTRUMENTS(armnn::Compute::CpuAcc, "Level 1B", TestInstrument()) |
| |
| { |
| ARMNN_SCOPED_PROFILING_EVENT_WITH_INSTRUMENTS(armnn::Compute::CpuAcc, "Level 2A", TestInstrument()) |
| } |
| } |
| } |
| } |
| |
| std::stringbuf buffer; |
| std::ostream json(&buffer); |
| profiler->Print(json); |
| |
| std::string output = buffer.str(); |
| armnn::IgnoreUnused(output); |
| |
| // Disable profiling here to not print out anything on stdout. |
| profiler->EnableProfiling(false); |
| |
| // blessed output validated by a human eyeballing the output to make sure it's ok and then copying it here. |
| // validation also included running the blessed output through an online json validation site |
| std::string blessedOutput("{\n\t\"ArmNN\": {\n\t\t\"inference_measurements_#1\": {\n\t\t\t\"type\": \"" |
| "Event\",\n\t\t\t\"Measurement1_#1\": {\n\t\t\t\t\"type\": \"" |
| "Measurement\",\n\t\t\t\t\"raw\": [\n\t\t\t\t\t1.000000\n\t\t\t\t],\n\t\t\t\t\"" |
| "unit\": \"ms\"\n\t\t\t},\n\t\t\t\"Measurement2_#1\": {\n\t\t\t\t\"type\": \"" |
| "Measurement\",\n\t\t\t\t\"raw\": [\n\t\t\t\t\t2.000000\n\t\t\t\t],\n\t\t\t\t\"" |
| "unit\": \"us\"\n\t\t\t},\n\t\t\t\"Level 0_#2\": {\n\t\t\t\t\"type\": \"" |
| "Event\",\n\t\t\t\t\"Measurement1_#2\": {\n\t\t\t\t\t\"type\": \"" |
| "Measurement\",\n\t\t\t\t\t\"raw\": [\n\t\t\t\t\t\t1.000000\n\t\t\t\t\t],\n\t\t\t\t\t\"" |
| "unit\": \"ms\"\n\t\t\t\t},\n\t\t\t\t\"Measurement2_#2\": {\n\t\t\t\t\t\"type\": \"" |
| "Measurement\",\n\t\t\t\t\t\"raw\": [\n\t\t\t\t\t\t2.000000\n\t\t\t\t\t],\n\t\t\t\t\t\"" |
| "unit\": \"us\"\n\t\t\t\t},\n\t\t\t\t\"Level 1A_#3\": {\n\t\t\t\t\t\"type\": \"" |
| "Event\",\n\t\t\t\t\t\"Measurement1_#3\": {\n\t\t\t\t\t\t\"type\": \"" |
| "Measurement\",\n\t\t\t\t\t\t\"raw\": [\n\t\t\t\t\t\t\t" |
| "1.000000\n\t\t\t\t\t\t],\n\t\t\t\t\t\t\"" |
| "unit\": \"ms\"\n\t\t\t\t\t},\n\t\t\t\t\t\"Measurement2_#3\": {\n\t\t\t\t\t\t\"type\": \"" |
| "Measurement\",\n\t\t\t\t\t\t\"raw\": [\n\t\t\t\t\t\t\t" |
| "2.000000\n\t\t\t\t\t\t],\n\t\t\t\t\t\t\"" |
| "unit\": \"us\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"Level 1B_#4\": {\n\t\t\t\t\t\"" |
| "type\": \"Event\",\n\t\t\t\t\t\"Measurement1_#4\": {\n\t\t\t\t\t\t\"type\": \"" |
| "Measurement\",\n\t\t\t\t\t\t\"raw\": [\n\t\t\t\t\t\t\t" |
| "1.000000\n\t\t\t\t\t\t],\n\t\t\t\t\t\t\"" |
| "unit\": \"ms\"\n\t\t\t\t\t},\n\t\t\t\t\t\"Measurement2_#4\": {\n\t\t\t\t\t\t\"" |
| "type\": \"Measurement\",\n\t\t\t\t\t\t\"raw\": [\n\t\t\t\t\t\t\t" |
| "2.000000\n\t\t\t\t\t\t],\n\t\t\t\t\t\t\"" |
| "unit\": \"us\"\n\t\t\t\t\t},\n\t\t\t\t\t\"Level 2A_#5\": {\n\t\t\t\t\t\t\"" |
| "type\": \"Event\",\n\t\t\t\t\t\t\"Measurement1_#5\": {\n\t\t\t\t\t\t\t\"type\": \"" |
| "Measurement\",\n\t\t\t\t\t\t\t\"raw\": [\n\t\t\t\t\t\t\t\t" |
| "1.000000\n\t\t\t\t\t\t\t],\n\t\t\t\t\t\t\t\"" |
| "unit\": \"ms\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"Measurement2_#5\": {\n\t\t\t\t\t\t\t\"" |
| "type\": \"Measurement\",\n\t\t\t\t\t\t\t\"raw\": [\n\t\t\t\t\t\t\t\t" |
| "2.000000\n\t\t\t\t\t\t\t],\n\t\t\t\t\t\t\t\"" |
| "unit\": \"us\"\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}\n"); |
| |
| BOOST_CHECK(output == blessedOutput); |
| armnn::ProfilerManager::GetInstance().RegisterProfiler(nullptr); |
| } |
| |
| BOOST_AUTO_TEST_SUITE_END(); |
