telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 1 | // |
| 2 | // Copyright © 2017 Arm Ltd. All rights reserved. |
| 3 | // See LICENSE file in the project root for full license information. |
| 4 | // |
| 5 | #pragma once |
| 6 | |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame^] | 7 | #include "ProfilingEvent.hpp" |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 8 | |
| 9 | #include "armnn/ArmNN.hpp" |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame^] | 10 | #include "armnn/IProfiler.hpp" |
| 11 | |
| 12 | #include "WallClockTimer.hpp" |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 13 | |
| 14 | #include <chrono> |
| 15 | #include <iosfwd> |
| 16 | #include <ctime> |
| 17 | #include <vector> |
| 18 | #include <stack> |
| 19 | #include <map> |
| 20 | |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame^] | 21 | #include <boost/core/ignore_unused.hpp> |
| 22 | |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 23 | namespace armnn |
| 24 | { |
| 25 | |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 26 | // Simple single-threaded profiler. |
| 27 | // Tracks events reported by BeginEvent()/EndEvent() and outputs detailed information and stats when |
| 28 | // Profiler::AnalyzeEventsAndWriteResults() is called. |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame^] | 29 | class Profiler final : public IProfiler |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 30 | { |
| 31 | public: |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame^] | 32 | Profiler(); |
| 33 | ~Profiler(); |
| 34 | using InstrumentPtr = std::unique_ptr<Instrument>; |
| 35 | |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 36 | // Marks the beginning of a user-defined event. |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame^] | 37 | // No attempt will be made to copy the name string: it must be known at compile time. |
| 38 | Event* BeginEvent(Compute compute, const std::string& name, std::vector<InstrumentPtr>&& instruments); |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 39 | |
| 40 | // Marks the end of a user-defined event. |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame^] | 41 | void EndEvent(Event* event); |
| 42 | |
| 43 | // Enables/disables profiling. |
| 44 | void EnableProfiling(bool enableProfiling) override; |
| 45 | |
| 46 | // Checks if profiling is enabled. |
| 47 | bool IsProfilingEnabled() override; |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 48 | |
| 49 | // Increments the event tag, allowing grouping of events in a user-defined manner (e.g. per inference). |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame^] | 50 | void UpdateEventTag(); |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 51 | |
| 52 | // Analyzes the tracked events and writes the results to the given output stream. |
| 53 | // Please refer to the configuration variables in Profiling.cpp to customize the information written. |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame^] | 54 | void AnalyzeEventsAndWriteResults(std::ostream& outStream) const override; |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 55 | |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame^] | 56 | // Print stats for events in JSON Format to the given output stream. |
| 57 | void Print(std::ostream& outStream) const override; |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 58 | |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame^] | 59 | // Gets the color to render an event with, based on which device it denotes. |
| 60 | uint32_t GetEventColor(Compute compute) const; |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 61 | |
| 62 | private: |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame^] | 63 | using EventPtr = std::unique_ptr<Event>; |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 64 | struct Marker |
| 65 | { |
| 66 | std::size_t m_Id; |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 67 | }; |
| 68 | |
| 69 | struct ProfilingEventStats |
| 70 | { |
| 71 | double m_TotalMs; |
| 72 | double m_MinMs; |
| 73 | double m_MaxMs; |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame^] | 74 | uint32_t m_Count; |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 75 | }; |
| 76 | |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 77 | // Waits for a compute device to finish working to guarantee correct timings. |
| 78 | // Currently used exclusively when emitting profiling events denoting GPU work. |
| 79 | void WaitForDevice(Compute compute) const; |
| 80 | |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame^] | 81 | template<typename EventIterType> |
| 82 | void AnalyzeEventSequenceAndWriteResults(EventIterType first, EventIterType last, std::ostream& outStream) const; |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 83 | |
| 84 | std::map<std::string, ProfilingEventStats> CalculateProfilingEventStats() const; |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame^] | 85 | void PopulateInferences(std::vector<const Event*>& outInferences, int& outBaseLevel) const; |
| 86 | void PopulateDescendants(std::map<const Event*, std::vector<const Event*>>& outDescendantsMap) const; |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 87 | |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame^] | 88 | std::stack<Event*> m_Parents; |
| 89 | std::vector<EventPtr> m_EventSequence; |
| 90 | bool m_ProfilingEnabled; |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 91 | |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame^] | 92 | private: |
| 93 | // Friend functions for unit testing, see ProfilerTests.cpp. |
| 94 | friend size_t GetProfilerEventSequenceSize(armnn::Profiler* profiler); |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 95 | }; |
| 96 | |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame^] | 97 | // Singleton profiler manager. |
| 98 | // Keeps track of all the running profiler instances. |
| 99 | class ProfilerManager |
| 100 | { |
| 101 | public: |
| 102 | // Register the given profiler as a thread local pointer. |
| 103 | void RegisterProfiler(Profiler* profiler); |
| 104 | |
| 105 | // Gets the thread local pointer to the profiler. |
| 106 | Profiler* GetProfiler(); |
| 107 | |
| 108 | // Accesses the singleton. |
| 109 | static ProfilerManager& GetInstance(); |
| 110 | |
| 111 | private: |
| 112 | // The constructor is kept private so that other instances of this class (other that the singleton's) |
| 113 | // can't be allocated. |
| 114 | ProfilerManager() {} |
| 115 | }; |
| 116 | |
| 117 | // Helper to easily add event markers to the codebase. |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 118 | class ScopedProfilingEvent |
| 119 | { |
| 120 | public: |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame^] | 121 | using InstrumentPtr = std::unique_ptr<Instrument>; |
| 122 | |
| 123 | template<typename... Args> |
| 124 | ScopedProfilingEvent(Compute compute, const std::string& name, Args... args) |
| 125 | : m_Event(nullptr) |
| 126 | , m_Profiler(ProfilerManager::GetInstance().GetProfiler()) |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 127 | { |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame^] | 128 | if (m_Profiler && m_Profiler->IsProfilingEnabled()) |
| 129 | { |
| 130 | std::vector<InstrumentPtr> instruments(0); |
| 131 | instruments.reserve(sizeof...(args)); //One allocation |
| 132 | ConstructNextInVector(instruments, args...); |
| 133 | m_Event = m_Profiler->BeginEvent(compute, name, std::move(instruments)); |
| 134 | } |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 135 | } |
| 136 | |
| 137 | ~ScopedProfilingEvent() |
| 138 | { |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame^] | 139 | if (m_Profiler && m_Event) |
| 140 | { |
| 141 | m_Profiler->EndEvent(m_Event); |
| 142 | } |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 143 | } |
| 144 | |
| 145 | private: |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame^] | 146 | |
| 147 | void ConstructNextInVector(std::vector<InstrumentPtr>& instruments) |
| 148 | { |
| 149 | boost::ignore_unused(instruments); |
| 150 | } |
| 151 | |
| 152 | template<typename Arg, typename... Args> |
| 153 | void ConstructNextInVector(std::vector<InstrumentPtr>& instruments, Arg arg, Args... args) |
| 154 | { |
| 155 | instruments.emplace_back(std::make_unique<Arg>(arg)); |
| 156 | ConstructNextInVector(instruments, args...); |
| 157 | } |
| 158 | |
| 159 | Event* m_Event; ///< Event to track |
| 160 | Profiler* m_Profiler; ///< Profiler used |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 161 | }; |
| 162 | |
| 163 | } // namespace armnn |
| 164 | |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 165 | // The event name must be known at compile time |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame^] | 166 | #define ARMNN_SCOPED_PROFILING_EVENT_WITH_INSTRUMENTS(compute, /*name,*/ ...) \ |
| 167 | armnn::ScopedProfilingEvent e_##__FILE__##__LINE__(compute, /*name,*/ __VA_ARGS__); |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 168 | |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame^] | 169 | #define ARMNN_SCOPED_PROFILING_EVENT(compute, name) \ |
| 170 | ARMNN_SCOPED_PROFILING_EVENT_WITH_INSTRUMENTS(compute, name, armnn::WallClockTimer()) |