1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
//
// Copyright © 2017 Arm Ltd. All rights reserved.
// SPDX-License-Identifier: MIT
//
#pragma once
#include <common/include/ProfilingGuid.hpp>
#include "ProfilingEvent.hpp"
#include "ProfilingDetails.hpp"
#include "armnn/IProfiler.hpp"
#include <armnn/Optional.hpp>
#include <armnn/utility/IgnoreUnused.hpp>
#include "WallClockTimer.hpp"
#include <chrono>
#include <iosfwd>
#include <ctime>
#include <vector>
#include <stack>
#include <map>
namespace armnn
{
// Simple single-threaded profiler.
// Tracks events reported by BeginEvent()/EndEvent() and outputs detailed information and stats when
// Profiler::AnalyzeEventsAndWriteResults() is called.
class ProfilerImpl
{
public:
ProfilerImpl();
~ProfilerImpl();
using InstrumentPtr = std::unique_ptr<Instrument>;
// Marks the beginning of a user-defined event.
// No attempt will be made to copy the name string: it must be known at compile time.
Event* BeginEvent(armnn::IProfiler* profiler,
const BackendId& backendId,
const std::string& name,
std::vector<InstrumentPtr>&& instruments,
const Optional<profiling::ProfilingGuid>& guid);
template<typename DescriptorType>
void AddLayerDetails(const std::string& label,
const DescriptorType& desc,
const WorkloadInfo& infos,
const profiling::ProfilingGuid guid)
{
m_ProfilingDetails->AddDetailsToString(label, desc, infos, guid);
}
// Marks the end of a user-defined event.
void EndEvent(Event* event);
// Enables/disables profiling.
void EnableProfiling(bool enableProfiling);
// Checks if profiling is enabled.
bool IsProfilingEnabled();
// Enables outputting the layer descriptors and infos to stdout
void EnableNetworkDetailsToStdOut();
// Increments the event tag, allowing grouping of events in a user-defined manner (e.g. per inference).
void UpdateEventTag();
// Analyzes the tracked events and writes the results to the given output stream.
// Please refer to the configuration variables in Profiling.cpp to customize the information written.
void AnalyzeEventsAndWriteResults(std::ostream& outStream) const;
// Print stats for events in JSON Format to the given output stream.
void Print(std::ostream& outStream) const;
// Gets the color to render an event with, based on which device it denotes.
uint32_t GetEventColor(const BackendId& backendId) const;
using EventPtr = std::unique_ptr<Event>;
using DescPtr = std::unique_ptr<ProfilingDetails>;
struct Marker
{
std::size_t m_Id;
};
struct ProfilingEventStats
{
double m_TotalMs;
double m_MinMs;
double m_MaxMs;
uint32_t m_Count;
};
template<typename EventIterType>
void AnalyzeEventSequenceAndWriteResults(EventIterType first, EventIterType last, std::ostream& outStream) const;
std::map<std::string, ProfilingEventStats> CalculateProfilingEventStats() const;
void PopulateInferences(std::vector<const Event*>& outInferences, int& outBaseLevel) const;
void PopulateDescendants(std::map<const Event*, std::vector<const Event*>>& outDescendantsMap) const;
std::stack<Event*> m_Parents;
std::vector<EventPtr> m_EventSequence;
DescPtr m_ProfilingDetails = std::make_unique<ProfilingDetails>();
bool m_ProfilingEnabled;
bool m_EnableDetailsToStdOut;
};
// Singleton profiler manager.
// Keeps track of all the running profiler instances.
class ProfilerManager
{
public:
// Register the given profiler as a thread local pointer.
void RegisterProfiler(IProfiler* profiler);
// Gets the thread local pointer to the profiler.
IProfiler* GetProfiler();
// Accesses the singleton.
static ProfilerManager& GetInstance();
private:
// The constructor is kept private so that other instances of this class (other that the singleton's)
// can't be allocated.
ProfilerManager() {}
};
// Helper to easily add event markers to the codebase.
class ScopedProfilingEvent
{
public:
using InstrumentPtr = std::unique_ptr<Instrument>;
template<typename... Args>
ScopedProfilingEvent(const BackendId& backendId,
const Optional<profiling::ProfilingGuid>& guid,
const std::string& name,
Args&& ... args)
: m_Event(nullptr)
, m_Profiler(ProfilerManager::GetInstance().GetProfiler())
{
if (m_Profiler && m_Profiler->IsProfilingEnabled())
{
std::vector<InstrumentPtr> instruments(0);
instruments.reserve(sizeof...(args)); //One allocation
ConstructNextInVector(instruments, std::forward<Args>(args)...);
m_Event = m_Profiler->BeginEvent(backendId, name, std::move(instruments), guid);
}
}
~ScopedProfilingEvent()
{
if (m_Profiler && m_Event)
{
m_Profiler->pProfilerImpl->EndEvent(m_Event);
}
}
private:
void ConstructNextInVector(std::vector<InstrumentPtr>& instruments)
{
IgnoreUnused(instruments);
}
template<typename Arg, typename... Args>
void ConstructNextInVector(std::vector<InstrumentPtr>& instruments, Arg&& arg, Args&&... args)
{
instruments.emplace_back(std::make_unique<Arg>(std::forward<Arg>(arg)));
ConstructNextInVector(instruments, std::forward<Args>(args)...);
}
Event* m_Event; ///< Event to track
IProfiler* m_Profiler; ///< Profiler used
};
// Helper to easily add operator details during profiling.
template<typename DescriptorType>
inline void ProfilingUpdateDescriptions(const std::string& name,
const DescriptorType& desc,
const WorkloadInfo& infos,
const profiling::ProfilingGuid guid)
{
IProfiler* profiler(ProfilerManager::GetInstance().GetProfiler()); ///< Profiler used
if (profiler && profiler->IsProfilingEnabled())
{
profiler->AddLayerDetails(name, desc, infos, guid);
}
}
template<typename DescriptorType>
void IProfiler::AddLayerDetails(const std::string& name,
const DescriptorType& desc,
const WorkloadInfo& infos,
const profiling::ProfilingGuid guid)
{
return pProfilerImpl->AddLayerDetails(name, desc, infos, guid);
}
} // namespace armnn
// Event Definitions for profiling
#define ARMNN_SCOPED_PROFILING_EVENT_WITH_INSTRUMENTS_UNIQUE_LOC_INNER(lineNumber, backendId, guid, /*name,*/ ...) \
armnn::ScopedProfilingEvent e_ ## lineNumber(backendId, guid, /*name,*/ __VA_ARGS__);
#define ARMNN_SCOPED_PROFILING_EVENT_WITH_INSTRUMENTS_UNIQUE_LOC(lineNumber, backendId, guid, /*name,*/ ...) \
ARMNN_SCOPED_PROFILING_EVENT_WITH_INSTRUMENTS_UNIQUE_LOC_INNER(lineNumber, backendId, guid, /*name,*/ __VA_ARGS__)
// The event name must be known at compile time i.e. if you are going to use this version of the macro
// in code the first argument you supply after the backendId must be the name.
// NOTE: need to pass the line number as an argument from here so by the time it gets to the UNIQUE_LOC_INNER
// above it has expanded to a string and will concat (##) correctly with the 'e_' prefix to yield a
// legal and unique variable name (so long as you don't use the macro twice on the same line).
// The concat preprocessing operator (##) very unhelpfully will not expand macros see
// https://gcc.gnu.org/onlinedocs/cpp/Concatenation.html for the gory details.
#define ARMNN_SCOPED_PROFILING_EVENT_WITH_INSTRUMENTS(backendId, guid, /*name,*/ ...) \
ARMNN_SCOPED_PROFILING_EVENT_WITH_INSTRUMENTS_UNIQUE_LOC(__LINE__,backendId, guid, /*name,*/ __VA_ARGS__)
#define ARMNN_SCOPED_PROFILING_EVENT(backendId, name) \
ARMNN_SCOPED_PROFILING_EVENT_WITH_INSTRUMENTS(backendId, armnn::EmptyOptional(), name, armnn::WallClockTimer())
#define ARMNN_SCOPED_PROFILING_EVENT_GUID(backendId, name, guid) \
ARMNN_SCOPED_PROFILING_EVENT_WITH_INSTRUMENTS(backendId, guid, name, armnn::WallClockTimer())
// Workload Description definitons for profiling
#define ARMNN_REPORT_PROFILING_WORKLOAD_DESC(name, desc, infos, guid) \
armnn::ProfilingUpdateDescriptions(name, desc, infos, guid);
|
