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
|
/************************************************************************
*
* Copyright (C) 2004-2024 IRCAD France
* Copyright (C) 2012-2015 IHU Strasbourg
*
* This file is part of Sight.
*
* Sight is free software: you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Sight is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sight. If not, see <https://www.gnu.org/licenses/>.
*
***********************************************************************/
#pragma once
#include "core/spy_log.hpp"
#include "core/timer.hpp"
// Define FW_PROFILING_DISABLED before including this header if you need to disable profiling output
namespace sight::core
{
/**
* @brief This class holds a timer. It displays elapsed time at destruction.
*/
class fw_profile_scope
{
public:
fw_profile_scope(const char* _label) :
m_label(_label)
{
m_timer.start();
}
~fw_profile_scope()
{
m_timer.stop();
SIGHT_INFO("TIMER : " << m_label << " = " << m_timer.get_elapsed_time_in_milli_sec() << " ms.");
}
/// Timer
core::timer m_timer;
/// Timer label
const char* m_label;
};
/**
* @brief This class holds a timer. It allows to compute the elapsed time between two profiling scopes.
*/
class fw_profile_frame_timer
{
public:
fw_profile_frame_timer(double _interval) :
m_interval(_interval)
{
m_timer.start();
}
//------------------------------------------------------------------------------
bool tick()
{
m_average = m_timer.get_elapsed_time_in_milli_sec() / ++m_count;
return m_timer.get_elapsed_time_in_milli_sec() >= m_interval * 1000;
}
//------------------------------------------------------------------------------
bool tick(core::clock::type _time)
{
m_average = (m_average * m_count + _time) / (m_count + 1);
++m_count;
return m_timer.get_elapsed_time_in_milli_sec() >= m_interval * 1000;
}
//------------------------------------------------------------------------------
void reset()
{
m_count = 0;
m_average = 0;
m_timer.reset();
}
/// Timer
core::timer m_timer;
/// Timer label
double m_interval;
/// Actual elapsed time average
double m_average {0};
/// Number of calls, used to compute the average
unsigned int m_count {0};
};
/**
* @brief This class holds a timer. It displays elapsed time at destruction every N seconds.
*/
class fw_profile_scope_avg
{
public:
fw_profile_scope_avg(const char* _label, fw_profile_frame_timer& _frame_timer) :
m_label(_label),
m_frame_timer(_frame_timer)
{
m_timer.start();
}
~fw_profile_scope_avg()
{
m_timer.stop();
if(m_frame_timer.tick(m_timer.get_elapsed_time_in_milli_sec()))
{
SIGHT_INFO(
"TIMER (avg over " << m_frame_timer.m_interval << "s) : "
<< m_label << " = " << m_frame_timer.m_average << " ms."
)
m_frame_timer.reset();
}
}
/// Timer
core::timer m_timer;
/// Timer label
const char* m_label;
/// Timer used to get the elapsed time between two profiling scopes
fw_profile_frame_timer& m_frame_timer;
};
/**
* @brief This class is used to compute the elapsed time between two profiling scopes.
*/
class fw_profile_frame
{
public:
fw_profile_frame(const char* _label, fw_profile_frame_timer& _frame_timer) :
m_label(_label),
m_frame_timer(_frame_timer)
{
SIGHT_INFO("FRAME : " << m_label << " = " << m_frame_timer.m_timer.get_elapsed_time_in_milli_sec() << " ms.");
m_frame_timer.reset();
}
~fw_profile_frame()
= default;
/// Timer label
const char* m_label;
/// Timer used to get the elapsed time between two profiling scopes
fw_profile_frame_timer& m_frame_timer;
};
/**
* @brief This class is used to compute the elapsed time between two profiling scopes every N seconds.
*/
class fw_profile_frame_avg
{
public:
fw_profile_frame_avg(const char* _label, fw_profile_frame_timer& _frame_timer) :
m_label(_label),
m_frame_timer(_frame_timer)
{
if(m_frame_timer.tick())
{
SIGHT_INFO(
"FRAME (avg over " << m_frame_timer.m_interval << "s) : "
<< m_label << " = " << m_frame_timer.m_average << " ms."
);
m_frame_timer.reset();
}
}
~fw_profile_frame_avg()
= default;
/// Timer label
const char* m_label;
/// Timer used to get the elapsed time between two profiling scopes
fw_profile_frame_timer& m_frame_timer;
};
#ifndef FW_PROFILING_DISABLED
/// Display the elapsed time inside a code block
#define FW_PROFILE(_label) \
sight::core::fw_profile_scope BOOST_PP_CAT(profiler, __LINE__)(_label);
/// Display the elapsed time inside a code block, every N seconds
#define FW_PROFILE_AVG(_label, interval) \
static sight::core::fw_profile_frame_timer BOOST_PP_CAT(frame_timer, __LINE__)(interval); \
sight::core::fw_profile_scope_avg BOOST_PP_CAT(profiler, __LINE__)(_label, BOOST_PP_CAT(frame_timer, __LINE__));
/// Display the elapsed time between two calls of a code block
#define FW_PROFILE_FRAME(_label) \
static sight::core::fw_profile_frame_timer BOOST_PP_CAT(frame_timer, __LINE__)(0); \
sight::core::fw_profile_frame BOOST_PP_CAT(profiler, __LINE__)(_label, BOOST_PP_CAT(frame_timer, __LINE__));
/// Display the elapsed time between two calls of a code block, every N seconds
#define FW_PROFILE_FRAME_AVG(_label, interval) \
static sight::core::fw_profile_frame_timer BOOST_PP_CAT(frame_timer, __LINE__)(interval); \
sight::core::fw_profile_frame_avg BOOST_PP_CAT(profiler, __LINE__)(_label, BOOST_PP_CAT(frame_timer, __LINE__));
#else // FW_PROFILING_DISABLED
#define FW_PROFILE(_label)
#define FW_PROFILE_AVG(_label, interval)
#define FW_PROFILE_FRAME(_label)
#define FW_PROFILE_FRAME_AVG(_label, interval)
#endif // FW_PROFILING_DISABLED
} //namespace sight::core
|
