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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
|
<!DOCTYPE HTML>
<html lang="en" class="light sidebar-visible" dir="ltr">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title>tracy - Notes</title>
<!-- Custom HTML head -->
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#ffffff">
<link rel="icon" href="../favicon.svg">
<link rel="shortcut icon" href="../favicon.png">
<link rel="stylesheet" href="../css/variables.css">
<link rel="stylesheet" href="../css/general.css">
<link rel="stylesheet" href="../css/chrome.css">
<link rel="stylesheet" href="../css/print.css" media="print">
<!-- Fonts -->
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
<link rel="stylesheet" href="../fonts/fonts.css">
<!-- Highlight.js Stylesheets -->
<link rel="stylesheet" id="highlight-css" href="../highlight.css">
<link rel="stylesheet" id="tomorrow-night-css" href="../tomorrow-night.css">
<link rel="stylesheet" id="ayu-highlight-css" href="../ayu-highlight.css">
<!-- Custom theme stylesheets -->
<!-- Provide site root to javascript -->
<script>
var path_to_root = "../";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
</script>
<!-- Start loading toc.js asap -->
<script src="../toc.js"></script>
</head>
<body>
<div id="body-container">
<!-- Work around some values being stored in localStorage wrapped in quotes -->
<script>
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') && theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
</script>
<!-- Set the theme before any content is loaded, prevents flash -->
<script>
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
const html = document.documentElement;
html.classList.remove('light')
html.classList.add(theme);
html.classList.add("js");
</script>
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
<!-- Hide / unhide sidebar before it is displayed -->
<script>
var sidebar = null;
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
} else {
sidebar = 'hidden';
}
sidebar_toggle.checked = sidebar === 'visible';
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
</script>
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
<!-- populated by js -->
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
<noscript>
<iframe class="sidebar-iframe-outer" src="../toc.html"></iframe>
</noscript>
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
<div class="sidebar-resize-indicator"></div>
</div>
</nav>
<div id="page-wrapper" class="page-wrapper">
<div class="page">
<div id="menu-bar-hover-placeholder"></div>
<div id="menu-bar" class="menu-bar sticky">
<div class="left-buttons">
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
<i class="fa fa-bars"></i>
</label>
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
<i class="fa fa-paint-brush"></i>
</button>
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
</ul>
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
<i class="fa fa-search"></i>
</button>
</div>
<h1 class="menu-title">Notes</h1>
<div class="right-buttons">
<a href="../print.html" title="Print this book" aria-label="Print this book">
<i id="print-button" class="fa fa-print"></i>
</a>
<a href="https://github.com/johannst/notes" title="Git repository" aria-label="Git repository">
<i id="git-repository-button" class="fa fa-github"></i>
</a>
</div>
</div>
<div id="search-wrapper" class="hidden">
<form id="searchbar-outer" class="searchbar-outer">
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
</form>
<div id="searchresults-outer" class="searchresults-outer hidden">
<div id="searchresults-header" class="searchresults-header"></div>
<ul id="searchresults">
</ul>
</div>
</div>
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
<script>
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
</script>
<div id="content" class="content">
<main>
<h1 id="tracy1"><a class="header" href="#tracy1">tracy(1)</a></h1>
<p><a href="https://github.com/wolfpld/tracy">Tracy</a> is a frame profiler, supporting manual code instrumentation
and providing a sampling profiler.</p>
<p>One can either record and visualize the profiling data live using
<code>tracy-profiler</code> or record the profiling data to a file using <code>tracy-capture</code>.</p>
<pre><code>tracy-profiler [file] [-p port]
tracy-capture -o file [-f] [-p port]
-f overwrite <file> if it exists
</code></pre>
<h2 id="example"><a class="header" href="#example">Example</a></h2>
<p>The example showcases different cases:</p>
<ol>
<li>Use tracy from a single binary. In that case the <code>TracyClient.cpp</code> can be
directly linked / included in the instrumented binary.</li>
<li>Use tracy from different binaries (eg main executable + shared library). In
this case the <code>TracyClient.cpp</code> should be compiled into its own shared
library, such that there is a single tracy client.</li>
<li>Use tracy from different binaries on windows. In this case the
<code>TracyClient.cpp</code> must be compiled again into a separate shared library,
while defining <code>TRACY_EXPORTS</code>. The code being instrumented must be compiled
with <code>TRACY_IMPORTS</code> defined.</li>
</ol>
<p>An instrumented <code>c++</code> example:</p>
<pre><code class="language-cpp">#include <chrono>
#include <thread>
#include <tracy/Tracy.hpp>
#ifdef USE_FOO
extern "C" void foo_comp_hook(int64_t);
#endif
void init() {
// Create a named zone (active for the current scope).
// Name will be used when rendering the zone in the thread timeline.
ZoneScopedN("init()");
// Set explicit color for the rendered zone.
ZoneColor(0xff0000);
std::this_thread::sleep_for(std::chrono::seconds(1));
}
void comp(const char* name) {
// Track call count.
static int64_t ccnt = 0;
ccnt += 1;
// Create an unnamed zone for the current scope.
ZoneScoped;
// Name the zone by formatting the name dynamically.
// This name is shown for the zone in the thread timeline, however
// in the zone statistics they are all accounted under one common
// zone "comp".
ZoneNameF("comp(%s)", name);
// Additional text to attach to the zone.
ZoneTextF("text(%s)", name);
// Additional value to attach to the zone measurement.
ZoneValue(ccnt);
// Statistics for dynamic names, text and values can be looked at in the zone
// statistics.There measurements can be grouped by different categories.
// Add a simple plot.
TracyPlot("comp-plot", ccnt % 4);
std::this_thread::sleep_for(std::chrono::milliseconds(100));
#ifdef USE_FOO
foo_comp_hook(ccnt);
#endif
}
void post_comp() {
// Create an unnamed zone for the current scope and capture callstack (max
// depth 10). Capturing callstack requires platform with TRACY_HAS_CALLSTACK
// support.
ZoneScopedS(10);
// Name the zone, w/o formatting.
const char name[] = "post_comp()";
ZoneName(name, sizeof(name));
// Add trace messages to the timeline.
TracyMessageL("start sleep in post_comp()");
std::this_thread::sleep_for(std::chrono::milliseconds(50));
TracyMessageL("end sleep in post_comp()");
}
void fini() {
// Create a named zone with an explicit color.
ZoneScopedNC("fini()", 0x00ff00);
std::this_thread::sleep_for(std::chrono::seconds(1));
}
int main() {
// Create a named zone.
ZoneScopedN("main()");
init();
int step = 0;
while (step++ < 10) {
// Create a frame message, this start a new frame with the name
// "step" and end the previous frame with the name "step".
FrameMarkNamed("step");
// Create a named scope.
ZoneScopedN("step()");
comp("a");
comp("b");
comp("c");
post_comp();
}
fini();
}
</code></pre>
<p>An instrumented <code>c</code> example:</p>
<pre><code class="language-c">#include <stdint.h>
#include <inttypes.h>
#include <stdio.h>
#include <tracy/TracyC.h>
static void comp_helper(int64_t i) {
char buf[64];
int cnt = snprintf(buf, sizeof(buf), "helper(%" PRId64 ")", i);
// Create an active unnamed zone.
TracyCZone(ctx, 1);
// Name the zone.
TracyCZoneName(ctx, buf, cnt);
// Add custom text to the zone measurement.
TracyCZoneText(ctx, buf, cnt);
// Add custom value to the zone measurement.
TracyCZoneValue(ctx, i);
for (int ii = 0; ii < i * 100000; ++ii) {
/* fake work */
}
// End the zone measurement.
TracyCZoneEnd(ctx);
}
void foo_comp_hook(int64_t cnt) {
// Create an active named zone.
TracyCZoneN(ctx, "foo", 1);
for (int i = 0; i < cnt; ++i) {
// Plot value.
TracyCPlot("foo_comp_hook", cnt + i);
comp_helper(i);
}
// Configure plot "foo", probably best done once during initialization..
TracyCPlotConfig("foo", TracyPlotFormatNumber, 1 /* step */, 1 /* fill */,
0xff0000);
// Plot value.
TracyCPlot("foo", cnt);
// End the zone measurement.
TracyCZoneEnd(ctx);
}
</code></pre>
<p>Raw build commands to demonstrate compiling tracy w/o <code>cmake</code>, in case we need
to integrate it into a different build system.</p>
<pre><code class="language-makefile">B := BUILD
main: $(B)/main-static $(B)/main-dynamic $(B)/main-dynamic-win
tracy: $(B)/tracy
.PHONY: main tracy
# -- TRACY STATIC ---------------------------------------------------------------
$(B)/main-static: main.cpp | $(B)
clang++ -DTRACY_ENABLE -I$(B)/tracy/public -o $@ $^ $(B)/tracy/public/TracyClient.cpp
# -- TRACY DYNAMIC --------------------------------------------------------------
$(B)/main-dynamic: main.cpp $(B)/foo.so $(B)/TracyClient.so | $(B)
clang++ -DTRACY_ENABLE -I$(B)/tracy/public -DUSE_FOO -o $@ $^
$(B)/foo.so: foo.c $(B)/TracyClient.so
clang -DTRACY_ENABLE -I$(B)/tracy/public -fPIC -shared -o $@ $^
$(B)/TracyClient.so: $(B)/tracy/public/TracyClient.cpp
clang++ -DTRACY_ENABLE -I$(B)/tracy/public -fPIC -shared -o $@ $^
# -- TRACY DYNAMIC WINDOWS ------------------------------------------------------
$(B)/main-dynamic-win: main.cpp $(B)/foo.dll $(B)/TracyClient.dll
@# eg run with wine
zig c++ -target x86_64-windows -DTRACY_ENABLE -DTRACY_IMPORTS -DUSE_FOO -o $@ $^ -I $(B)/tracy/public
$(B)/foo.dll: foo.c $(B)/TracyClient.dll
zig c++ -target x86_64-windows -DTRACY_ENABLE -DTRACY_IMPORTS -fPIC -shared -o $@ $^ -I $(B)/tracy/public
$(B)/TracyClient.dll: $(B)/tracy/public/TracyClient.cpp
@# win libs from 'pragma comment(lib, ..)'
zig c++ -target x86_64-windows -DTRACY_ENABLE -DTRACY_EXPORTS -fPIC -shared -o $@ $^ -lws2_32 -ldbghelp -ladvapi32 -luser32
# -- TRACY ----------------------------------------------------------------------
# Get latest tracy and build profiler.
$(B)/tracy: $(B)
cd $(B); bash $(CURDIR)/get-tracy.sh
.PHONY: $(B)/tracy
$B:
mkdir -p $(B)
.PHONY: $(B)
# -- CLEAN ----------------------------------------------------------------------
clean:
$(RM) $(B)/*.so $(B)/*.dll $(B)/*.pdb $(B)/*.lib $(B)/main*
distclean:
rm -rf $(B)
</code></pre>
<blockquote>
<p>Find <code>get-tracy.sh</code> <a href="https://github.com/johannst/notes/blob/master/src/trace_profile/tracy/get-tracy.sh">here</a>.</p>
</blockquote>
</main>
<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->
<a rel="prev" href="../trace_profile/vtune.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
<a rel="next prefetch" href="../debug/index.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
<div style="clear: both"></div>
</nav>
</div>
</div>
<nav class="nav-wide-wrapper" aria-label="Page navigation">
<a rel="prev" href="../trace_profile/vtune.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
<a rel="next prefetch" href="../debug/index.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
</nav>
</div>
<script>
window.playground_copyable = true;
</script>
<script src="../elasticlunr.min.js"></script>
<script src="../mark.min.js"></script>
<script src="../searcher.js"></script>
<script src="../clipboard.min.js"></script>
<script src="../highlight.js"></script>
<script src="../book.js"></script>
<!-- Custom JS scripts -->
</div>
</body>
</html>
|
