Ginkgo: ginkgo/core/log/profiler_hook.hpp Source File

| Ginkgo Generated from branch based on main. Ginkgo version 1.11.0 A numerical linear algebra library targeting many-core architectures

Loading...
Searching...
No Matches
profiler_hook.hpp
1// SPDX-FileCopyrightText: 2017 - 2024 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#ifndef GKO_PUBLIC_CORE_LOG_PROFILER_HOOK_HPP_
6#define GKO_PUBLIC_CORE_LOG_PROFILER_HOOK_HPP_
7
8
9#include <iostream>
10#include <unordered_map>
11
12#include <ginkgo/config.hpp>
13#include <ginkgo/core/base/timer.hpp>
14#include <ginkgo/core/log/logger.hpp>
15
16
17namespace gko {
18namespace log {
19
20
22 enum class profile_event_category {
24 memory,
26 operation,
28 object,
30 linop,
32 factory,
34 solver,
36 criterion,
38 user,
40 internal,
41};
42
43
44class profiling_scope_guard;
45
46
57 class ProfilerHook : public Logger {
58public:
59 using hook_function =
60 std::function<void(const char*, profile_event_category)>;
61
62 void on_allocation_started(const gko::Executor* exec,
63 const gko::size_type&) const override;
64
65 void on_allocation_completed(const gko::Executor* exec,
66 const gko::size_type&,
67 const gko::uintptr&) const override;
68
69 void on_free_started(const gko::Executor* exec,
70 const gko::uintptr&) const override;
71
72 void on_free_completed(const gko::Executor* exec,
73 const gko::uintptr&) const override;
74
75 void on_copy_started(const gko::Executor* from, const gko::Executor* to,
76 const gko::uintptr&, const gko::uintptr&,
77 const gko::size_type&) const override;
78
79 void on_copy_completed(const gko::Executor* from, const gko::Executor* to,
80 const gko::uintptr&, const gko::uintptr&,
81 const gko::size_type&) const override;
82
83 /* Operation events */
84 void on_operation_launched(const Executor* exec,
85 const Operation* operation) const override;
86
87 void on_operation_completed(const Executor* exec,
88 const Operation* operation) const override;
89
90 /* PolymorphicObject events */
91 void on_polymorphic_object_copy_started(
92 const Executor* exec, const PolymorphicObject* from,
93 const PolymorphicObject* to) const override;
94
95 void on_polymorphic_object_copy_completed(
96 const Executor* exec, const PolymorphicObject* from,
97 const PolymorphicObject* to) const override;
98
99 void on_polymorphic_object_move_started(
100 const Executor* exec, const PolymorphicObject* from,
101 const PolymorphicObject* to) const override;
102
103 void on_polymorphic_object_move_completed(
104 const Executor* exec, const PolymorphicObject* from,
105 const PolymorphicObject* to) const override;
106
107 /* LinOp events */
108 void on_linop_apply_started(const LinOp* A, const LinOp* b,
109 const LinOp* x) const override;
110
111 void on_linop_apply_completed(const LinOp* A, const LinOp* b,
112 const LinOp* x) const override;
113
114 void on_linop_advanced_apply_started(const LinOp* A, const LinOp* alpha,
115 const LinOp* b, const LinOp* beta,
116 const LinOp* x) const override;
117
118 void on_linop_advanced_apply_completed(const LinOp* A, const LinOp* alpha,
119 const LinOp* b, const LinOp* beta,
120 const LinOp* x) const override;
121
122 /* LinOpFactory events */
123 void on_linop_factory_generate_started(const LinOpFactory* factory,
124 const LinOp* input) const override;
125
126 void on_linop_factory_generate_completed(
127 const LinOpFactory* factory, const LinOp* input,
128 const LinOp* output) const override;
129
130 /* Criterion events */
131 void on_criterion_check_started(const stop::Criterion* criterion,
132 const size_type& num_iterations,
133 const LinOp* residual,
134 const LinOp* residual_norm,
135 const LinOp* solution,
136 const uint8& stopping_id,
137 const bool& set_finalized) const override;
138
139 void on_criterion_check_completed(
140 const stop::Criterion* criterion, const size_type& num_iterations,
141 const LinOp* residual, const LinOp* residual_norm,
142 const LinOp* solution, const uint8& stopping_id,
143 const bool& set_finalized, const array<stopping_status>* status,
144 const bool& one_changed, const bool& all_stopped) const override;
145
146 void on_criterion_check_completed(
147 const stop::Criterion* criterion, const size_type& num_iterations,
148 const LinOp* residual, const LinOp* residual_norm,
149 const LinOp* implicit_sq_resnorm, const LinOp* solution,
150 const uint8& stopping_id, const bool& set_finalized,
151 const array<stopping_status>* status, const bool& one_changed,
152 const bool& all_stopped) const override;
153
154 /* Internal solver events */
155 void on_iteration_complete(
156 const LinOp* solver, const LinOp* right_hand_side,
157 const LinOp* solution, const size_type& num_iterations,
158 const LinOp* residual, const LinOp* residual_norm,
159 const LinOp* implicit_sq_residual_norm,
160 const array<stopping_status>* status, bool stopped) const override;
161
162 GKO_DEPRECATED(
163 "Please use the version with the additional stopping "
164 "information.")
165 void on_iteration_complete(const LinOp* solver,
166 const size_type& num_iterations,
167 const LinOp* residual, const LinOp* solution,
168 const LinOp* residual_norm) const override;
169
170 GKO_DEPRECATED(
171 "Please use the version with the additional stopping "
172 "information.")
173 void on_iteration_complete(
174 const LinOp* solver, const size_type& num_iterations,
175 const LinOp* residual, const LinOp* solution,
176 const LinOp* residual_norm,
177 const LinOp* implicit_sq_residual_norm) const override;
178
179 bool needs_propagation() const override;
180
188 void set_object_name(ptr_param<const PolymorphicObject> obj,
189 std::string name);
190
196 void set_synchronization(bool synchronize);
197
207 profiling_scope_guard user_range(const char* name) const;
208
210 constexpr static uint32 color_yellow_argb = 0xFFFFCB05U;
211
220 static std::shared_ptr<ProfilerHook> create_tau(bool initialize = true);
221
225 static std::shared_ptr<ProfilerHook> create_vtune();
226
232 static std::shared_ptr<ProfilerHook> create_nvtx(
233 uint32 color_argb = color_yellow_argb);
234
238 static std::shared_ptr<ProfilerHook> create_roctx();
239
245 static std::shared_ptr<ProfilerHook> create_for_executor(
246 std::shared_ptr<const Executor> exec);
247
248 struct summary_entry {
250 std::string name;
252 std::chrono::nanoseconds inclusive{0};
257 std::chrono::nanoseconds exclusive{0};
259 int64 count{};
260 };
261
262 struct nested_summary_entry {
264 std::string name;
266 std::chrono::nanoseconds elapsed{0};
268 int64 count{};
270 std::vector<nested_summary_entry> children{};
271 };
272
274 class SummaryWriter {
275 public:
276 virtual ~SummaryWriter() = default;
277
284 virtual void write(const std::vector<summary_entry>& entries,
285 std::chrono::nanoseconds overhead) = 0;
286 };
287
289 class NestedSummaryWriter {
290 public:
291 virtual ~NestedSummaryWriter() = default;
292
299 virtual void write_nested(const nested_summary_entry& root,
300 std::chrono::nanoseconds overhead) = 0;
301 };
302
308 class TableSummaryWriter : public SummaryWriter,
309 public NestedSummaryWriter {
310 public:
317 TableSummaryWriter(std::ostream& output = std::cerr,
318 std::string header = "Runtime summary");
319
320 void write(const std::vector<summary_entry>& entries,
321 std::chrono::nanoseconds overhead) override;
322
323 void write_nested(const nested_summary_entry& root,
324 std::chrono::nanoseconds overhead) override;
325
326 private:
327 std::ostream* output_;
328 std::string header_;
329 };
330
347 static std::shared_ptr<ProfilerHook> create_summary(
348 std::shared_ptr<Timer> timer = std::make_shared<CpuTimer>(),
349 std::unique_ptr<SummaryWriter> writer =
350 std::make_unique<TableSummaryWriter>(),
351 bool debug_check_nesting = false);
352
370 static std::shared_ptr<ProfilerHook> create_nested_summary(
371 std::shared_ptr<Timer> timer = std::make_shared<CpuTimer>(),
372 std::unique_ptr<NestedSummaryWriter> writer =
373 std::make_unique<TableSummaryWriter>(),
374 bool debug_check_nesting = false);
375
380 static std::shared_ptr<ProfilerHook> create_custom(hook_function begin,
381 hook_function end);
382
383private:
384 ProfilerHook(hook_function begin, hook_function end);
385
386 void maybe_synchronize(const Executor* exec) const;
387
388 std::string stringify_object(const PolymorphicObject* obj) const;
389
390 std::unordered_map<const PolymorphicObject*, std::string> name_map_;
391 bool synchronize_;
392 hook_function begin_hook_;
393 hook_function end_hook_;
394};
395
396
400 class profiling_scope_guard {
401public:
403 profiling_scope_guard();
404
413 profiling_scope_guard(const char* name, profile_event_category category,
414 ProfilerHook::hook_function begin,
415 ProfilerHook::hook_function end);
416
418 ~profiling_scope_guard();
419
420 profiling_scope_guard(const profiling_scope_guard&) = delete;
421
422 profiling_scope_guard(profiling_scope_guard&& other) = delete;
423
424 profiling_scope_guard& operator=(const profiling_scope_guard&) = delete;
425
426 profiling_scope_guard& operator=(profiling_scope_guard&&) = delete;
427
428private:
429 bool empty_;
430 const char* name_;
431 profile_event_category category_;
432 ProfilerHook::hook_function end_;
433};
434
435
436} // namespace log
437} // namespace gko
438
439
440#endif // GKO_PUBLIC_CORE_LOG_PROFILER_HOOK_HPP_
gko::Executor
The first step in using the Ginkgo library consists of creating an executor.
Definition executor.hpp:615
gko::LinOpFactory
A LinOpFactory represents a higher order mapping which transforms one linear operator into another.
Definition lin_op.hpp:385
gko::LinOp
Definition lin_op.hpp:117
gko::Operation
Operations can be used to define functionalities whose implementations differ among devices.
Definition executor.hpp:258
gko::PolymorphicObject
A PolymorphicObject is the abstract base for all "heavy" objects in Ginkgo that behave polymorphicall...
Definition polymorphic_object.hpp:52
gko::array
An array is a container which encapsulates fixed-sized arrays, stored on the Executor tied to the arr...
Definition array.hpp:166
gko::log::ProfilerHook::NestedSummaryWriter
Receives the results from ProfilerHook::create_nested_summary().
Definition profiler_hook.hpp:289
gko::log::ProfilerHook::NestedSummaryWriter::write_nested
virtual void write_nested(const nested_summary_entry &root, std::chrono::nanoseconds overhead)=0
Callback to write out the summary results.
gko::log::ProfilerHook::SummaryWriter
Receives the results from ProfilerHook::create_summary().
Definition profiler_hook.hpp:274
gko::log::ProfilerHook::SummaryWriter::write
virtual void write(const std::vector< summary_entry > &entries, std::chrono::nanoseconds overhead)=0
Callback to write out the summary results.
gko::log::ProfilerHook::TableSummaryWriter::TableSummaryWriter
TableSummaryWriter(std::ostream &output=std::cerr, std::string header="Runtime summary")
Constructs a writer on an output stream.
gko::log::ProfilerHook::TableSummaryWriter::write
void write(const std::vector< summary_entry > &entries, std::chrono::nanoseconds overhead) override
Callback to write out the summary results.
gko::log::ProfilerHook::TableSummaryWriter::write_nested
void write_nested(const nested_summary_entry &root, std::chrono::nanoseconds overhead) override
Callback to write out the summary results.
gko::log::ProfilerHook::create_nvtx
static std::shared_ptr< ProfilerHook > create_nvtx(uint32 color_argb=color_yellow_argb)
Creates a logger annotating Ginkgo events with NVTX ranges for CUDA.
gko::log::ProfilerHook::set_object_name
void set_object_name(ptr_param< const PolymorphicObject > obj, std::string name)
Sets the name for an object to be profiled.
gko::log::ProfilerHook::on_linop_apply_completed
void on_linop_apply_completed(const LinOp *A, const LinOp *b, const LinOp *x) const override
LinOp's apply completed event.
gko::log::ProfilerHook::on_polymorphic_object_move_completed
void on_polymorphic_object_move_completed(const Executor *exec, const PolymorphicObject *from, const PolymorphicObject *to) const override
PolymorphicObject's move completed event.
gko::log::ProfilerHook::on_polymorphic_object_copy_started
void on_polymorphic_object_copy_started(const Executor *exec, const PolymorphicObject *from, const PolymorphicObject *to) const override
PolymorphicObject's copy started event.
gko::log::ProfilerHook::on_copy_completed
void on_copy_completed(const gko::Executor *from, const gko::Executor *to, const gko::uintptr &, const gko::uintptr &, const gko::size_type &) const override
Executor's copy completed event.
gko::log::ProfilerHook::create_summary
static std::shared_ptr< ProfilerHook > create_summary(std::shared_ptr< Timer > timer=std::make_shared< CpuTimer >(), std::unique_ptr< SummaryWriter > writer=std::make_unique< TableSummaryWriter >(), bool debug_check_nesting=false)
Creates a logger measuring the runtime of Ginkgo events and printing a summary when it is destroyed.
gko::log::ProfilerHook::user_range
profiling_scope_guard user_range(const char *name) const
Creates a scope guard for a user-defined range to be included in the profile.
gko::log::ProfilerHook::create_nested_summary
static std::shared_ptr< ProfilerHook > create_nested_summary(std::shared_ptr< Timer > timer=std::make_shared< CpuTimer >(), std::unique_ptr< NestedSummaryWriter > writer=std::make_unique< TableSummaryWriter >(), bool debug_check_nesting=false)
Creates a logger measuring the runtime of Ginkgo events in a nested fashion and printing a summary wh...
gko::log::ProfilerHook::on_polymorphic_object_copy_completed
void on_polymorphic_object_copy_completed(const Executor *exec, const PolymorphicObject *from, const PolymorphicObject *to) const override
PolymorphicObject's copy completed event.
gko::log::ProfilerHook::on_criterion_check_completed
void on_criterion_check_completed(const stop::Criterion *criterion, const size_type &num_iterations, const LinOp *residual, const LinOp *residual_norm, const LinOp *implicit_sq_resnorm, const LinOp *solution, const uint8 &stopping_id, const bool &set_finalized, const array< stopping_status > *status, const bool &one_changed, const bool &all_stopped) const override
stop::Criterion's check completed event.
gko::log::ProfilerHook::create_roctx
static std::shared_ptr< ProfilerHook > create_roctx()
Creates a logger annotating Ginkgo events with ROCTX ranges for HIP.
gko::log::ProfilerHook::on_copy_started
void on_copy_started(const gko::Executor *from, const gko::Executor *to, const gko::uintptr &, const gko::uintptr &, const gko::size_type &) const override
Executor's copy started event.
gko::log::ProfilerHook::create_for_executor
static std::shared_ptr< ProfilerHook > create_for_executor(std::shared_ptr< const Executor > exec)
Creates a logger annotating Ginkgo events with the most suitable backend for the given executor: NVTX...
gko::log::ProfilerHook::create_custom
static std::shared_ptr< ProfilerHook > create_custom(hook_function begin, hook_function end)
Creates a logger annotating Ginkgo events with a custom set of functions for range begin and end.
gko::log::ProfilerHook::on_linop_advanced_apply_completed
void on_linop_advanced_apply_completed(const LinOp *A, const LinOp *alpha, const LinOp *b, const LinOp *beta, const LinOp *x) const override
LinOp's advanced apply completed event.
gko::log::ProfilerHook::create_vtune
static std::shared_ptr< ProfilerHook > create_vtune()
Creates a logger annotating Ginkgo events with VTune ITT ranges.
gko::log::ProfilerHook::on_allocation_completed
void on_allocation_completed(const gko::Executor *exec, const gko::size_type &, const gko::uintptr &) const override
Executor's allocation completed event.
gko::log::ProfilerHook::color_yellow_argb
static constexpr uint32 color_yellow_argb
The Ginkgo yellow background color as packed 32 bit ARGB value.
Definition profiler_hook.hpp:210
gko::log::ProfilerHook::create_tau
static std::shared_ptr< ProfilerHook > create_tau(bool initialize=true)
Creates a logger annotating Ginkgo events with TAU ranges via PerfStubs.
gko::log::ProfilerHook::set_synchronization
void set_synchronization(bool synchronize)
Should the events call executor->synchronize on operations and copy/allocation?
gko::log::ProfilerHook::on_free_completed
void on_free_completed(const gko::Executor *exec, const gko::uintptr &) const override
Executor's free completed event.
gko::log::ProfilerHook::on_criterion_check_started
void on_criterion_check_started(const stop::Criterion *criterion, const size_type &num_iterations, const LinOp *residual, const LinOp *residual_norm, const LinOp *solution, const uint8 &stopping_id, const bool &set_finalized) const override
stop::Criterion's check started event.
gko::log::ProfilerHook::on_iteration_complete
void on_iteration_complete(const LinOp *solver, const LinOp *right_hand_side, const LinOp *solution, const size_type &num_iterations, const LinOp *residual, const LinOp *residual_norm, const LinOp *implicit_sq_residual_norm, const array< stopping_status > *status, bool stopped) const override
Register the iteration_complete event which logs every completed iterations.
gko::log::ProfilerHook::on_linop_factory_generate_started
void on_linop_factory_generate_started(const LinOpFactory *factory, const LinOp *input) const override
LinOp Factory's generate started event.
gko::log::ProfilerHook::on_linop_factory_generate_completed
void on_linop_factory_generate_completed(const LinOpFactory *factory, const LinOp *input, const LinOp *output) const override
LinOp Factory's generate completed event.
gko::log::ProfilerHook::on_linop_advanced_apply_started
void on_linop_advanced_apply_started(const LinOp *A, const LinOp *alpha, const LinOp *b, const LinOp *beta, const LinOp *x) const override
LinOp's advanced apply started event.
gko::log::ProfilerHook::on_operation_completed
void on_operation_completed(const Executor *exec, const Operation *operation) const override
Executor's operation completed event (method run).
gko::log::ProfilerHook::needs_propagation
bool needs_propagation() const override
Returns true if this logger, when attached to an Executor, needs to be forwarded all events from obje...
gko::log::ProfilerHook::on_criterion_check_completed
void on_criterion_check_completed(const stop::Criterion *criterion, const size_type &num_iterations, const LinOp *residual, const LinOp *residual_norm, const LinOp *solution, const uint8 &stopping_id, const bool &set_finalized, const array< stopping_status > *status, const bool &one_changed, const bool &all_stopped) const override
stop::Criterion's check completed event.
gko::log::ProfilerHook::on_polymorphic_object_move_started
void on_polymorphic_object_move_started(const Executor *exec, const PolymorphicObject *from, const PolymorphicObject *to) const override
PolymorphicObject's move started event.
gko::log::ProfilerHook::on_linop_apply_started
void on_linop_apply_started(const LinOp *A, const LinOp *b, const LinOp *x) const override
LinOp's apply started event.
gko::log::ProfilerHook::on_allocation_started
void on_allocation_started(const gko::Executor *exec, const gko::size_type &) const override
Executor's allocation started event.
gko::log::ProfilerHook::on_free_started
void on_free_started(const gko::Executor *exec, const gko::uintptr &) const override
Executor's free started event.
gko::log::ProfilerHook::on_operation_launched
void on_operation_launched(const Executor *exec, const Operation *operation) const override
Executor's operation launched event (method run).
gko::log::profiling_scope_guard
Scope guard that annotates its scope with the provided profiler hooks.
Definition profiler_hook.hpp:400
gko::log::profiling_scope_guard::profiling_scope_guard
profiling_scope_guard()
Creates an empty (moved-from) scope guard.
gko::log::profiling_scope_guard::~profiling_scope_guard
~profiling_scope_guard()
Calls the range end function if the scope guard was not moved from.
gko::log::profiling_scope_guard::profiling_scope_guard
profiling_scope_guard(const char *name, profile_event_category category, ProfilerHook::hook_function begin, ProfilerHook::hook_function end)
Creates the scope guard.
gko::ptr_param
This class is used for function parameters in the place of raw pointers.
Definition utils_helper.hpp:41
gko::stop::Criterion
The Criterion class is a base class for all stopping criteria.
Definition criterion.hpp:36
gko::initialize
std::unique_ptr< Matrix > initialize(size_type stride, std::initializer_list< typename Matrix::value_type > vals, std::shared_ptr< const Executor > exec, TArgs &&... create_args)
Creates and initializes a column-vector.
Definition dense.hpp:1593
gko::log
The logger namespace .
Definition convergence.hpp:22
gko::log::profile_event_category
profile_event_category
Categorization of logger events.
Definition profiler_hook.hpp:22
gko::log::profile_event_category::criterion
@ criterion
Stopping criterion events.
Definition profiler_hook.hpp:36
gko::log::profile_event_category::factory
@ factory
LinOpFactory events.
Definition profiler_hook.hpp:32
gko::log::profile_event_category::object
@ object
PolymorphicObject events.
Definition profiler_hook.hpp:28
gko::log::profile_event_category::memory
@ memory
Memory allocation.
Definition profiler_hook.hpp:24
gko::log::profile_event_category::internal
@ internal
For development use.
Definition profiler_hook.hpp:40
gko::log::profile_event_category::user
@ user
User-defined events.
Definition profiler_hook.hpp:38
gko::log::profile_event_category::linop
@ linop
LinOp events.
Definition profiler_hook.hpp:30
gko::log::profile_event_category::operation
@ operation
Kernel execution and data movement.
Definition profiler_hook.hpp:26
gko::solver
The ginkgo Solve namespace.
Definition bicg.hpp:28
gko
The Ginkgo namespace.
Definition abstract_factory.hpp:20
gko::uint8
std::uint8_t uint8
8-bit unsigned integral type.
Definition types.hpp:119
gko::uintptr
std::uintptr_t uintptr
Unsigned integer type capable of holding a pointer to void.
Definition types.hpp:142
gko::uint32
std::uint32_t uint32
32-bit unsigned integral type.
Definition types.hpp:130
gko::int64
std::int64_t int64
64-bit signed integral type.
Definition types.hpp:113
gko::size_type
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:90
std
STL namespace.
gko::log::ProfilerHook::nested_summary_entry
Definition profiler_hook.hpp:262
gko::log::ProfilerHook::nested_summary_entry::children
std::vector< nested_summary_entry > children
The nested ranges inside this range.
Definition profiler_hook.hpp:270
gko::log::ProfilerHook::nested_summary_entry::name
std::string name
The name of the range.
Definition profiler_hook.hpp:264
gko::log::ProfilerHook::nested_summary_entry::elapsed
std::chrono::nanoseconds elapsed
The total runtime of all invocations of the range in nanoseconds.
Definition profiler_hook.hpp:266
gko::log::ProfilerHook::nested_summary_entry::count
int64 count
The total number of invocations of the range.
Definition profiler_hook.hpp:268
gko::log::ProfilerHook::summary_entry
Definition profiler_hook.hpp:248
gko::log::ProfilerHook::summary_entry::exclusive
std::chrono::nanoseconds exclusive
The total runtime of all invocations of the range in nanoseconds, excluding the runtime of all nested...
Definition profiler_hook.hpp:257
gko::log::ProfilerHook::summary_entry::name
std::string name
The name of the range.
Definition profiler_hook.hpp:250
gko::log::ProfilerHook::summary_entry::inclusive
std::chrono::nanoseconds inclusive
The total runtime of all invocations of the range in nanoseconds.
Definition profiler_hook.hpp:252
gko::log::ProfilerHook::summary_entry::count
int64 count
The total number of invocations of the range.
Definition profiler_hook.hpp:259