-
Notifications
You must be signed in to change notification settings - Fork 0
/
flamegraph.pl
executable file
·1763 lines (1662 loc) · 60 KB
/
flamegraph.pl
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
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/perl -w
# License: https://github.com/brendangregg/FlameGraph/blob/master/docs/cddl1.txt
# COMMON DEVELOPMENT AND DISTRIBUTION LICENSE Version 1.0
#
# 1. Definitions.
#
# 1.1. "Contributor" means each individual or entity that creates
# or contributes to the creation of Modifications.
#
# 1.2. "Contributor Version" means the combination of the Original
# Software, prior Modifications used by a Contributor (if any),
# and the Modifications made by that particular Contributor.
#
# 1.3. "Covered Software" means (a) the Original Software, or (b)
# Modifications, or (c) the combination of files containing
# Original Software with files containing Modifications, in
# each case including portions thereof.
#
# 1.4. "Executable" means the Covered Software in any form other
# than Source Code.
#
# 1.5. "Initial Developer" means the individual or entity that first
# makes Original Software available under this License.
#
# 1.6. "Larger Work" means a work which combines Covered Software or
# portions thereof with code not governed by the terms of this
# License.
#
# 1.7. "License" means this document.
#
# 1.8. "Licensable" means having the right to grant, to the maximum
# extent possible, whether at the time of the initial grant or
# subsequently acquired, any and all of the rights conveyed
# herein.
#
# 1.9. "Modifications" means the Source Code and Executable form of
# any of the following:
#
# A. Any file that results from an addition to, deletion from or
# modification of the contents of a file containing Original
# Software or previous Modifications;
#
# B. Any new file that contains any part of the Original
# Software or previous Modifications; or
#
# C. Any new file that is contributed or otherwise made
# available under the terms of this License.
#
# 1.10. "Original Software" means the Source Code and Executable
# form of computer software code that is originally released
# under this License.
#
# 1.11. "Patent Claims" means any patent claim(s), now owned or
# hereafter acquired, including without limitation, method,
# process, and apparatus claims, in any patent Licensable by
# grantor.
#
# 1.12. "Source Code" means (a) the common form of computer software
# code in which modifications are made and (b) associated
# documentation included in or with such code.
#
# 1.13. "You" (or "Your") means an individual or a legal entity
# exercising rights under, and complying with all of the terms
# of, this License. For legal entities, "You" includes any
# entity which controls, is controlled by, or is under common
# control with You. For purposes of this definition,
# "control" means (a) the power, direct or indirect, to cause
# the direction or management of such entity, whether by
# contract or otherwise, or (b) ownership of more than fifty
# percent (50%) of the outstanding shares or beneficial
# ownership of such entity.
#
# 2. License Grants.
#
# 2.1. The Initial Developer Grant.
#
# Conditioned upon Your compliance with Section 3.1 below and
# subject to third party intellectual property claims, the Initial
# Developer hereby grants You a world-wide, royalty-free,
# non-exclusive license:
#
# (a) under intellectual property rights (other than patent or
# trademark) Licensable by Initial Developer, to use,
# reproduce, modify, display, perform, sublicense and
# distribute the Original Software (or portions thereof),
# with or without Modifications, and/or as part of a Larger
# Work; and
#
# (b) under Patent Claims infringed by the making, using or
# selling of Original Software, to make, have made, use,
# practice, sell, and offer for sale, and/or otherwise
# dispose of the Original Software (or portions thereof).
#
# (c) The licenses granted in Sections 2.1(a) and (b) are
# effective on the date Initial Developer first distributes
# or otherwise makes the Original Software available to a
# third party under the terms of this License.
#
# (d) Notwithstanding Section 2.1(b) above, no patent license is
# granted: (1) for code that You delete from the Original
# Software, or (2) for infringements caused by: (i) the
# modification of the Original Software, or (ii) the
# combination of the Original Software with other software
# or devices.
#
# 2.2. Contributor Grant.
#
# Conditioned upon Your compliance with Section 3.1 below and
# subject to third party intellectual property claims, each
# Contributor hereby grants You a world-wide, royalty-free,
# non-exclusive license:
#
# (a) under intellectual property rights (other than patent or
# trademark) Licensable by Contributor to use, reproduce,
# modify, display, perform, sublicense and distribute the
# Modifications created by such Contributor (or portions
# thereof), either on an unmodified basis, with other
# Modifications, as Covered Software and/or as part of a
# Larger Work; and
#
# (b) under Patent Claims infringed by the making, using, or
# selling of Modifications made by that Contributor either
# alone and/or in combination with its Contributor Version
# (or portions of such combination), to make, use, sell,
# offer for sale, have made, and/or otherwise dispose of:
# (1) Modifications made by that Contributor (or portions
# thereof); and (2) the combination of Modifications made by
# that Contributor with its Contributor Version (or portions
# of such combination).
#
# (c) The licenses granted in Sections 2.2(a) and 2.2(b) are
# effective on the date Contributor first distributes or
# otherwise makes the Modifications available to a third
# party.
#
# (d) Notwithstanding Section 2.2(b) above, no patent license is
# granted: (1) for any code that Contributor has deleted
# from the Contributor Version; (2) for infringements caused
# by: (i) third party modifications of Contributor Version,
# or (ii) the combination of Modifications made by that
# Contributor with other software (except as part of the
# Contributor Version) or other devices; or (3) under Patent
# Claims infringed by Covered Software in the absence of
# Modifications made by that Contributor.
#
# 3. Distribution Obligations.
#
# 3.1. Availability of Source Code.
#
# Any Covered Software that You distribute or otherwise make
# available in Executable form must also be made available in Source
# Code form and that Source Code form must be distributed only under
# the terms of this License. You must include a copy of this
# License with every copy of the Source Code form of the Covered
# Software You distribute or otherwise make available. You must
# inform recipients of any such Covered Software in Executable form
# as to how they can obtain such Covered Software in Source Code
# form in a reasonable manner on or through a medium customarily
# used for software exchange.
#
# 3.2. Modifications.
#
# The Modifications that You create or to which You contribute are
# governed by the terms of this License. You represent that You
# believe Your Modifications are Your original creation(s) and/or
# You have sufficient rights to grant the rights conveyed by this
# License.
#
# 3.3. Required Notices.
#
# You must include a notice in each of Your Modifications that
# identifies You as the Contributor of the Modification. You may
# not remove or alter any copyright, patent or trademark notices
# contained within the Covered Software, or any notices of licensing
# or any descriptive text giving attribution to any Contributor or
# the Initial Developer.
#
# 3.4. Application of Additional Terms.
#
# You may not offer or impose any terms on any Covered Software in
# Source Code form that alters or restricts the applicable version
# of this License or the recipients' rights hereunder. You may
# choose to offer, and to charge a fee for, warranty, support,
# indemnity or liability obligations to one or more recipients of
# Covered Software. However, you may do so only on Your own behalf,
# and not on behalf of the Initial Developer or any Contributor.
# You must make it absolutely clear that any such warranty, support,
# indemnity or liability obligation is offered by You alone, and You
# hereby agree to indemnify the Initial Developer and every
# Contributor for any liability incurred by the Initial Developer or
# such Contributor as a result of warranty, support, indemnity or
# liability terms You offer.
#
# 3.5. Distribution of Executable Versions.
#
# You may distribute the Executable form of the Covered Software
# under the terms of this License or under the terms of a license of
# Your choice, which may contain terms different from this License,
# provided that You are in compliance with the terms of this License
# and that the license for the Executable form does not attempt to
# limit or alter the recipient's rights in the Source Code form from
# the rights set forth in this License. If You distribute the
# Covered Software in Executable form under a different license, You
# must make it absolutely clear that any terms which differ from
# this License are offered by You alone, not by the Initial
# Developer or Contributor. You hereby agree to indemnify the
# Initial Developer and every Contributor for any liability incurred
# by the Initial Developer or such Contributor as a result of any
# such terms You offer.
#
# 3.6. Larger Works.
#
# You may create a Larger Work by combining Covered Software with
# other code not governed by the terms of this License and
# distribute the Larger Work as a single product. In such a case,
# You must make sure the requirements of this License are fulfilled
# for the Covered Software.
#
# 4. Versions of the License.
#
# 4.1. New Versions.
#
# Sun Microsystems, Inc. is the initial license steward and may
# publish revised and/or new versions of this License from time to
# time. Each version will be given a distinguishing version number.
# Except as provided in Section 4.3, no one other than the license
# steward has the right to modify this License.
#
# 4.2. Effect of New Versions.
#
# You may always continue to use, distribute or otherwise make the
# Covered Software available under the terms of the version of the
# License under which You originally received the Covered Software.
# If the Initial Developer includes a notice in the Original
# Software prohibiting it from being distributed or otherwise made
# available under any subsequent version of the License, You must
# distribute and make the Covered Software available under the terms
# of the version of the License under which You originally received
# the Covered Software. Otherwise, You may also choose to use,
# distribute or otherwise make the Covered Software available under
# the terms of any subsequent version of the License published by
# the license steward.
#
# 4.3. Modified Versions.
#
# When You are an Initial Developer and You want to create a new
# license for Your Original Software, You may create and use a
# modified version of this License if You: (a) rename the license
# and remove any references to the name of the license steward
# (except to note that the license differs from this License); and
# (b) otherwise make it clear that the license contains terms which
# differ from this License.
#
# 5. DISCLAIMER OF WARRANTY.
#
# COVERED SOFTWARE IS PROVIDED UNDER THIS LICENSE ON AN "AS IS"
# BASIS, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
# INCLUDING, WITHOUT LIMITATION, WARRANTIES THAT THE COVERED
# SOFTWARE IS FREE OF DEFECTS, MERCHANTABLE, FIT FOR A PARTICULAR
# PURPOSE OR NON-INFRINGING. THE ENTIRE RISK AS TO THE QUALITY AND
# PERFORMANCE OF THE COVERED SOFTWARE IS WITH YOU. SHOULD ANY
# COVERED SOFTWARE PROVE DEFECTIVE IN ANY RESPECT, YOU (NOT THE
# INITIAL DEVELOPER OR ANY OTHER CONTRIBUTOR) ASSUME THE COST OF ANY
# NECESSARY SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER OF
# WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. NO USE OF
# ANY COVERED SOFTWARE IS AUTHORIZED HEREUNDER EXCEPT UNDER THIS
# DISCLAIMER.
#
# 6. TERMINATION.
#
# 6.1. This License and the rights granted hereunder will terminate
# automatically if You fail to comply with terms herein and fail to
# cure such breach within 30 days of becoming aware of the breach.
# Provisions which, by their nature, must remain in effect beyond
# the termination of this License shall survive.
#
# 6.2. If You assert a patent infringement claim (excluding
# declaratory judgment actions) against Initial Developer or a
# Contributor (the Initial Developer or Contributor against whom You
# assert such claim is referred to as "Participant") alleging that
# the Participant Software (meaning the Contributor Version where
# the Participant is a Contributor or the Original Software where
# the Participant is the Initial Developer) directly or indirectly
# infringes any patent, then any and all rights granted directly or
# indirectly to You by such Participant, the Initial Developer (if
# the Initial Developer is not the Participant) and all Contributors
# under Sections 2.1 and/or 2.2 of this License shall, upon 60 days
# notice from Participant terminate prospectively and automatically
# at the expiration of such 60 day notice period, unless if within
# such 60 day period You withdraw Your claim with respect to the
# Participant Software against such Participant either unilaterally
# or pursuant to a written agreement with Participant.
#
# 6.3. In the event of termination under Sections 6.1 or 6.2 above,
# all end user licenses that have been validly granted by You or any
# distributor hereunder prior to termination (excluding licenses
# granted to You by any distributor) shall survive termination.
#
# 7. LIMITATION OF LIABILITY.
#
# UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER TORT
# (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL YOU, THE
# INITIAL DEVELOPER, ANY OTHER CONTRIBUTOR, OR ANY DISTRIBUTOR OF
# COVERED SOFTWARE, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE
# LIABLE TO ANY PERSON FOR ANY INDIRECT, SPECIAL, INCIDENTAL, OR
# CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT
# LIMITATION, DAMAGES FOR LOST PROFITS, LOSS OF GOODWILL, WORK
# STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER
# COMMERCIAL DAMAGES OR LOSSES, EVEN IF SUCH PARTY SHALL HAVE BEEN
# INFORMED OF THE POSSIBILITY OF SUCH DAMAGES. THIS LIMITATION OF
# LIABILITY SHALL NOT APPLY TO LIABILITY FOR DEATH OR PERSONAL
# INJURY RESULTING FROM SUCH PARTY'S NEGLIGENCE TO THE EXTENT
# APPLICABLE LAW PROHIBITS SUCH LIMITATION. SOME JURISDICTIONS DO
# NOT ALLOW THE EXCLUSION OR LIMITATION OF INCIDENTAL OR
# CONSEQUENTIAL DAMAGES, SO THIS EXCLUSION AND LIMITATION MAY NOT
# APPLY TO YOU.
#
# 8. U.S. GOVERNMENT END USERS.
#
# The Covered Software is a "commercial item," as that term is
# defined in 48 C.F.R. 2.101 (Oct. 1995), consisting of "commercial
# computer software" (as that term is defined at 48
# C.F.R. 252.227-7014(a)(1)) and "commercial computer software
# documentation" as such terms are used in 48 C.F.R. 12.212
# (Sept. 1995). Consistent with 48 C.F.R. 12.212 and 48
# C.F.R. 227.7202-1 through 227.7202-4 (June 1995), all
# U.S. Government End Users acquire Covered Software with only those
# rights set forth herein. This U.S. Government Rights clause is in
# lieu of, and supersedes, any other FAR, DFAR, or other clause or
# provision that addresses Government rights in computer software
# under this License.
#
# 9. MISCELLANEOUS.
#
# This License represents the complete agreement concerning subject
# matter hereof. If any provision of this License is held to be
# unenforceable, such provision shall be reformed only to the extent
# necessary to make it enforceable. This License shall be governed
# by the law of the jurisdiction specified in a notice contained
# within the Original Software (except to the extent applicable law,
# if any, provides otherwise), excluding such jurisdiction's
# conflict-of-law provisions. Any litigation relating to this
# License shall be subject to the jurisdiction of the courts located
# in the jurisdiction and venue specified in a notice contained
# within the Original Software, with the losing party responsible
# for costs, including, without limitation, court costs and
# reasonable attorneys' fees and expenses. The application of the
# United Nations Convention on Contracts for the International Sale
# of Goods is expressly excluded. Any law or regulation which
# provides that the language of a contract shall be construed
# against the drafter shall not apply to this License. You agree
# that You alone are responsible for compliance with the United
# States export administration regulations (and the export control
# laws and regulation of any other countries) when You use,
# distribute or otherwise make available any Covered Software.
#
# 10. RESPONSIBILITY FOR CLAIMS.
#
# As between Initial Developer and the Contributors, each party is
# responsible for claims and damages arising, directly or
# indirectly, out of its utilization of rights under this License
# and You agree to work with Initial Developer and Contributors to
# distribute such responsibility on an equitable basis. Nothing
# herein is intended or shall be deemed to constitute any admission
# of liability.
#
# --------------------------------------------------------------------
#
# NOTICE PURSUANT TO SECTION 9 OF THE COMMON DEVELOPMENT AND
# DISTRIBUTION LICENSE (CDDL)
#
# For Covered Software in this distribution, this License shall
# be governed by the laws of the State of California (excluding
# conflict-of-law provisions).
#
# Any litigation relating to this License shall be subject to the
# jurisdiction of the Federal Courts of the Northern District of
# California and the state courts of the State of California, with
# venue lying in Santa Clara County, California.
#
#
# flamegraph.pl flame stack grapher.
#
# This takes stack samples and renders a call graph, allowing hot functions
# and codepaths to be quickly identified. Stack samples can be generated using
# tools such as DTrace, perf, SystemTap, and Instruments.
#
# USAGE: ./flamegraph.pl [options] input.txt > graph.svg
#
# grep funcA input.txt | ./flamegraph.pl [options] > graph.svg
#
# Then open the resulting .svg in a web browser, for interactivity: mouse-over
# frames for info, click to zoom, and ctrl-F to search.
#
# Options are listed in the usage message (--help).
#
# The input is stack frames and sample counts formatted as single lines. Each
# frame in the stack is semicolon separated, with a space and count at the end
# of the line. These can be generated for Linux perf script output using
# stackcollapse-perf.pl, for DTrace using stackcollapse.pl, and for other tools
# using the other stackcollapse programs. Example input:
#
# swapper;start_kernel;rest_init;cpu_idle;default_idle;native_safe_halt 1
#
# An optional extra column of counts can be provided to generate a differential
# flame graph of the counts, colored red for more, and blue for less. This
# can be useful when using flame graphs for non-regression testing.
# See the header comment in the difffolded.pl program for instructions.
#
# The input functions can optionally have annotations at the end of each
# function name, following a precedent by some tools (Linux perf's _[k]):
# _[k] for kernel
# _[i] for inlined
# _[j] for jit
# _[w] for waker
# Some of the stackcollapse programs support adding these annotations, eg,
# stackcollapse-perf.pl --kernel --jit. They are used merely for colors by
# some palettes, eg, flamegraph.pl --color=java.
#
# The output flame graph shows relative presence of functions in stack samples.
# The ordering on the x-axis has no meaning; since the data is samples, time
# order of events is not known. The order used sorts function names
# alphabetically.
#
# While intended to process stack samples, this can also process stack traces.
# For example, tracing stacks for memory allocation, or resource usage. You
# can use --title to set the title to reflect the content, and --countname
# to change "samples" to "bytes" etc.
#
# There are a few different palettes, selectable using --color. By default,
# the colors are selected at random (except for differentials). Functions
# called "-" will be printed gray, which can be used for stack separators (eg,
# between user and kernel stacks).
#
# HISTORY
#
# This was inspired by Neelakanth Nadgir's excellent function_call_graph.rb
# program, which visualized function entry and return trace events. As Neel
# wrote: "The output displayed is inspired by Roch's CallStackAnalyzer which
# was in turn inspired by the work on vftrace by Jan Boerhout". See:
# https://blogs.oracle.com/realneel/entry/visualizing_callstacks_via_dtrace_and
#
# Copyright 2024 IBM Corporation. All Rights Reserved.
# Copyright 2016 Netflix, Inc.
# Copyright 2011 Joyent, Inc. All rights reserved.
# Copyright 2011 Brendan Gregg. All rights reserved.
#
# CDDL HEADER START
#
# The contents of this file are subject to the terms of the
# Common Development and Distribution License (the "License").
# You may not use this file except in compliance with the License.
#
# You can obtain a copy of the license at docs/cddl1.txt or
# http://opensource.org/licenses/CDDL-1.0.
# See the License for the specific language governing permissions
# and limitations under the License.
#
# When distributing Covered Code, include this CDDL HEADER in each
# file and include the License file at docs/cddl1.txt.
# If applicable, add the following below this CDDL HEADER, with the
# fields enclosed by brackets "[]" replaced with your own identifying
# information: Portions Copyright [yyyy] [name of copyright owner]
#
# CDDL HEADER END
#
#-------------------------------------------------------------------
#
# REVISION HISTORY
#
# 02-May-2024 Kevin Grigorenko (IBM)
# Added right click handler which pops up additional information.
# Changed some of the coloring.
#
# 11-Oct-2014 Adrien Mahieux
# Added zoom.
#
# 21-Nov-2013 Shawn Sterling
# Added consistent palette file option
#
# 17-Mar-2013 Tim Bunce
# Added options and more tunables.
#
# 15-Dec-2011 Dave Pacheco
# Support for frames with whitespace.
#
# 10-Sep-2011 Brendan Gregg
# Created this.
use strict;
use Getopt::Long;
use open qw(:std :utf8);
# tunables
my $encoding;
my $fonttype = "Verdana";
my $imagewidth = 1200; # max width, pixels
my $frameheight = 16; # max height is dynamic
my $fontsize = 12; # base text size
my $fontwidth = 0.59; # avg width relative to fontsize
my $minwidth = 0.1; # min function width, pixels or percentage of time
my $nametype = "Function:"; # what are the names in the data?
my $countname = "samples"; # what are the counts in the data?
my $colors = "hot"; # color theme
my $bgcolors = ""; # background color theme
my $nameattrfile; # file holding function attributes
my $timemax; # (override the) sum of the counts
my $factor = 1; # factor to scale counts by
my $hash = 0; # color by function name
my $rand = 0; # color randomly
my $palette = 0; # if we use consistent palettes (default off)
my %palette_map; # palette map hash
my $pal_file = "palette.map"; # palette map file name
my $stackreverse = 0; # reverse stack order, switching merge end
my $inverted = 0; # icicle graph
my $flamechart = 0; # produce a flame chart (sort by time, do not merge stacks)
my $negate = 0; # switch differential hues
my $titletext = ""; # centered heading
my $titledefault = "Flame Graph"; # overwritten by --title
my $titleinverted = "Icicle Graph"; # " "
my $searchcolor = "rgb(230,0,230)"; # color for search highlighting
my $notestext = ""; # embedded notes in SVG
my $subtitletext = ""; # second level title (optional)
my $help = 0;
sub usage {
die <<USAGE_END;
USAGE: $0 [options] infile > outfile.svg\n
--title TEXT # change title text
--subtitle TEXT # second level title (optional)
--width NUM # width of image (default 1200)
--height NUM # height of each frame (default 16)
--minwidth NUM # omit smaller functions. In pixels or use "%" for
# percentage of time (default 0.1 pixels)
--fonttype FONT # font type (default "Verdana")
--fontsize NUM # font size (default 12)
--countname TEXT # count type label (default "samples")
--nametype TEXT # name type label (default "Function:")
--colors PALETTE # set color palette. choices are: hot (default), mem,
# io, wakeup, chain, java, js, perl, red, green, blue,
# aqua, yellow, purple, orange
--bgcolors COLOR # set background colors. gradient choices are yellow
# (default), blue, green, grey; flat colors use "#rrggbb"
--hash # colors are keyed by function name hash
--random # colors are randomly generated
--cp # use consistent palette (palette.map)
--reverse # generate stack-reversed flame graph
--inverted # icicle graph
--flamechart # produce a flame chart (sort by time, do not merge stacks)
--negate # switch differential hues (blue<->red)
--notes TEXT # add notes comment in SVG (for debugging)
--help # this message
eg,
$0 --title="Flame Graph: malloc()" trace.txt > graph.svg
USAGE_END
}
GetOptions(
'fonttype=s' => \$fonttype,
'width=i' => \$imagewidth,
'height=i' => \$frameheight,
'encoding=s' => \$encoding,
'fontsize=f' => \$fontsize,
'fontwidth=f' => \$fontwidth,
'minwidth=s' => \$minwidth,
'title=s' => \$titletext,
'subtitle=s' => \$subtitletext,
'nametype=s' => \$nametype,
'countname=s' => \$countname,
'nameattr=s' => \$nameattrfile,
'total=s' => \$timemax,
'factor=f' => \$factor,
'colors=s' => \$colors,
'bgcolors=s' => \$bgcolors,
'hash' => \$hash,
'random' => \$rand,
'cp' => \$palette,
'reverse' => \$stackreverse,
'inverted' => \$inverted,
'flamechart' => \$flamechart,
'negate' => \$negate,
'notes=s' => \$notestext,
'help' => \$help,
) or usage();
$help && usage();
# internals
my $ypad1 = $fontsize * 3; # pad top, include title
my $ypad2 = $fontsize * 2 + 10; # pad bottom, include labels
my $ypad3 = $fontsize * 2; # pad top, include subtitle (optional)
my $xpad = 10; # pad lefm and right
my $framepad = 1; # vertical padding for frames
my $depthmax = 0;
my %Events;
my %nameattr;
if ($flamechart && $titletext eq "") {
$titletext = "Flame Chart";
}
if ($titletext eq "") {
unless ($inverted) {
$titletext = $titledefault;
} else {
$titletext = $titleinverted;
}
}
if ($nameattrfile) {
# The name-attribute file format is a function name followed by a tab then
# a sequence of tab separated name=value pairs.
open my $attrfh, $nameattrfile or die "Can't read $nameattrfile: $!\n";
while (<$attrfh>) {
chomp;
my ($funcname, $attrstr) = split /\t/, $_, 2;
die "Invalid format in $nameattrfile" unless defined $attrstr;
$nameattr{$funcname} = { map { split /=/, $_, 2 } split /\t/, $attrstr };
}
}
if ($notestext =~ /[<>]/) {
die "Notes string can't contain < or >"
}
# Ensure minwidth is a valid floating-point number,
# print usage string if not
my $minwidth_f;
if ($minwidth =~ /^([0-9.]+)%?$/) {
$minwidth_f = $1;
} else {
warn "Value '$minwidth' is invalid for minwidth, expected a float.\n";
usage();
}
# background colors:
# - yellow gradient: default (hot, java, js, perl)
# - green gradient: mem
# - blue gradient: io, wakeup, chain
# - gray gradient: flat colors (red, green, blue, ...)
if ($bgcolors eq "") {
# choose a default
if ($colors eq "mem") {
$bgcolors = "green";
} elsif ($colors =~ /^(io|wakeup|chain)$/) {
$bgcolors = "blue";
} elsif ($colors =~ /^(red|green|blue|aqua|yellow|purple|orange)$/) {
$bgcolors = "grey";
} else {
$bgcolors = "yellow";
}
}
my ($bgcolor1, $bgcolor2);
if ($bgcolors eq "yellow") {
$bgcolor1 = "#eeeeee"; # background color gradient start
$bgcolor2 = "#eeeeb0"; # background color gradient stop
} elsif ($bgcolors eq "blue") {
$bgcolor1 = "#eeeeee"; $bgcolor2 = "#e0e0ff";
} elsif ($bgcolors eq "green") {
$bgcolor1 = "#eef2ee"; $bgcolor2 = "#e0ffe0";
} elsif ($bgcolors eq "grey") {
$bgcolor1 = "#f8f8f8"; $bgcolor2 = "#e8e8e8";
} elsif ($bgcolors =~ /^#......$/) {
$bgcolor1 = $bgcolor2 = $bgcolors;
} else {
die "Unrecognized bgcolor option \"$bgcolors\""
}
# SVG functions
{ package SVG;
sub new {
my $class = shift;
my $self = {};
bless ($self, $class);
return $self;
}
sub header {
my ($self, $w, $h) = @_;
my $enc_attr = '';
if (defined $encoding) {
$enc_attr = qq{ encoding="$encoding"};
}
$self->{svg} .= <<SVG;
<?xml version="1.0"$enc_attr standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg version="1.1" width="$w" height="$h" onload="init(evt)" viewBox="0 0 $w $h" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- Flame graph stack visualization. See https://github.com/brendangregg/FlameGraph for latest version, and http://www.brendangregg.com/flamegraphs.html for examples. -->
<!-- NOTES: $notestext -->
SVG
}
sub include {
my ($self, $content) = @_;
$self->{svg} .= $content;
}
sub colorAllocate {
my ($self, $r, $g, $b) = @_;
return "rgb($r,$g,$b)";
}
sub group_start {
my ($self, $attr) = @_;
my @g_attr = map {
exists $attr->{$_} ? sprintf(qq/$_="%s"/, $attr->{$_}) : ()
} qw(id class);
push @g_attr, $attr->{g_extra} if $attr->{g_extra};
if ($attr->{href}) {
my @a_attr;
push @a_attr, sprintf qq/xlink:href="%s"/, $attr->{href} if $attr->{href};
# default target=_top else links will open within SVG <object>
push @a_attr, sprintf qq/target="%s"/, $attr->{target} || "_top";
push @a_attr, $attr->{a_extra} if $attr->{a_extra};
$self->{svg} .= sprintf qq/<a %s>\n/, join(' ', (@a_attr, @g_attr));
} else {
$self->{svg} .= sprintf qq/<g %s>\n/, join(' ', @g_attr);
}
$self->{svg} .= sprintf qq/<title>%s<\/title>/, $attr->{title}
if $attr->{title}; # should be first element within g container
}
sub group_end {
my ($self, $attr) = @_;
$self->{svg} .= $attr->{href} ? qq/<\/a>\n/ : qq/<\/g>\n/;
}
sub filledRectangle {
my ($self, $x1, $y1, $x2, $y2, $fill, $extra) = @_;
$x1 = sprintf "%0.1f", $x1;
$x2 = sprintf "%0.1f", $x2;
my $w = sprintf "%0.1f", $x2 - $x1;
my $h = sprintf "%0.1f", $y2 - $y1;
$extra = defined $extra ? $extra : "";
$self->{svg} .= qq/<rect x="$x1" y="$y1" width="$w" height="$h" fill="$fill" $extra \/>\n/;
}
sub stringTTF {
my ($self, $id, $x, $y, $str, $extra) = @_;
$x = sprintf "%0.2f", $x;
$id = defined $id ? qq/id="$id"/ : "";
$extra ||= "";
$self->{svg} .= qq/<text $id x="$x" y="$y" $extra>$str<\/text>\n/;
}
sub svg {
my $self = shift;
return "$self->{svg}</svg>\n";
}
1;
}
sub namehash {
# Generate a vector hash for the name string, weighting early over
# later characters. We want to pick the same colors for function
# names across different flame graphs.
my $name = shift;
my $vector = 0;
my $weight = 1;
my $max = 1;
my $mod = 10;
# if module name present, trunc to 1st char
$name =~ s/.(.*?)`//;
foreach my $c (split //, $name) {
my $i = (ord $c) % $mod;
$vector += ($i / ($mod++ - 1)) * $weight;
$max += 1 * $weight;
$weight *= 0.70;
last if $mod > 12;
}
return (1 - $vector / $max)
}
sub sum_namehash {
my $name = shift;
return unpack("%32W*", $name);
}
sub random_namehash {
# Generate a random hash for the name string.
# This ensures that functions with the same name have the same color,
# both within a flamegraph and across multiple flamegraphs without
# needing to set a palette and while preserving the original flamegraph
# optic, unlike what happens with --hash.
my $name = shift;
my $hash = sum_namehash($name);
srand($hash);
return rand(1)
}
sub color {
my ($type, $hash, $name, $width) = @_;
my ($v1, $v2, $v3);
if ($hash) {
$v1 = namehash($name);
$v2 = $v3 = namehash(scalar reverse $name);
} elsif ($rand) {
$v1 = rand(1);
$v2 = rand(1);
$v3 = rand(1);
} else {
$v1 = random_namehash($name);
$v2 = random_namehash($name);
$v3 = random_namehash($name);
}
# theme palettes
if (defined $type and $type eq "hot") {
my $r = 205 + int(50 * $v3);
my $g = 0 + int(230 * $v1);
my $b = 0 + int(55 * $v2);
return "rgb($r,$g,$b)";
}
if (defined $type and $type eq "mem") {
my $r = 0;
my $g = 190 + int(50 * $v2);
my $b = 0 + int(210 * $v1);
return "rgb($r,$g,$b)";
}
if (defined $type and $type eq "io") {
my $r = 80 + int(60 * $v1);
my $g = $r;
my $b = 190 + int(55 * $v2);
return "rgb($r,$g,$b)";
}
# multi palettes
if (defined $type and $type eq "java") {
# Handle both annotations (_[j], _[i], ...; which are
# accurate), as well as input that lacks any annotations, as
# best as possible. Without annotations, we get a little hacky
# and match on java|org|com, etc.
if ($name =~ m:_\[j\]$:) { # jit annotation
$type = "green";
} elsif ($name =~ m:_\[i\]$:) { # inline annotation
$type = "aqua";
} elsif ($name =~ m:^L?(java|javax|jdk|net|org|com|io|sun)/:) { # Java
$type = "green";
} elsif ($name =~ /:::/) { # Java, typical perf-map-agent method separator
$type = "green";
} elsif ($name =~ /::/) { # C++
$type = "yellow";
} elsif ($name =~ m:_\[k\]$:) { # kernel annotation
$type = "orange";
} elsif ($name =~ /::/) { # C++
$type = "yellow";
} else { # system
$type = "red";
}
# fall-through to color palettes
}
if (defined $type and $type eq "perl") {
if ($name =~ /::/) { # C++
$type = "yellow";
} elsif ($name =~ m:Perl: or $name =~ m:\.pl:) { # Perl
$type = "green";
} elsif ($name =~ m:_\[k\]$:) { # kernel
$type = "orange";
} else { # system
$type = "red";
}
# fall-through to color palettes
}
if (defined $type and $type eq "js") {
# Handle both annotations (_[j], _[i], ...; which are
# accurate), as well as input that lacks any annotations, as
# best as possible. Without annotations, we get a little hacky,
# and match on a "/" with a ".js", etc.
if ($name =~ m:_\[j\]$:) { # jit annotation
if ($name =~ m:/:) {
$type = "green"; # source
} else {
$type = "aqua"; # builtin
}
} elsif ($name =~ /::/) { # C++
$type = "yellow";
} elsif ($name =~ m:/.*\.js:) { # JavaScript (match "/" in path)
$type = "green";
} elsif ($name =~ m/:/) { # JavaScript (match ":" in builtin)
$type = "aqua";
} elsif ($name =~ m/^ $/) { # Missing symbol
$type = "green";
} elsif ($name =~ m:_\[k\]:) { # kernel
$type = "orange";
} else { # system
$type = "red";
}
# fall-through to color palettes
}
if (defined $type and $type eq "wakeup") {
$type = "aqua";
# fall-through to color palettes
}
if (defined $type and $type eq "chain") {
if ($name =~ m:_\[w\]:) { # waker
$type = "aqua"
} else { # off-CPU
$type = "blue";
}
# fall-through to color palettes
}
# color palettes
if (defined $type and $type eq "red") {
#my $r = 200 + int(55 * $v1);
#my $x = 50 + int(80 * $v1);
my $r = 255;
my $g = 0;
my $proportion = ($width / $imagewidth);
if ($proportion > 0.2) {
$g = int(75 * (1 - $proportion));
} elsif ($proportion > 0.1) {
$g = 75 + int(25 * (1 - $proportion));
} elsif ($proportion > 0.05) {
$g = 100 + int(50 * (1 - ($proportion * 10)));
} else {
$g = 150 + int(50 * (1 - ($proportion * 10)));
}
return "rgb($r,$g,0)";
}
if (defined $type and $type eq "green") {
my $g = 200 + int(55 * $v1);
my $x = 50 + int(60 * $v1);
return "rgb($x,$g,$x)";
}
if (defined $type and $type eq "blue") {
my $b = 205 + int(50 * $v1);
my $x = 80 + int(60 * $v1);
return "rgb($x,$x,$b)";
}
if (defined $type and $type eq "yellow") {
my $x = 175 + int(55 * $v1);
my $b = 50 + int(20 * $v1);
return "rgb($x,$x,$b)";
}
if (defined $type and $type eq "purple") {
my $x = 190 + int(65 * $v1);
my $g = 80 + int(60 * $v1);
return "rgb($x,$g,$x)";
}
if (defined $type and $type eq "aqua") {
my $r = 50 + int(60 * $v1);
my $g = 165 + int(55 * $v1);
my $b = 165 + int(55 * $v1);
return "rgb($r,$g,$b)";
}
if (defined $type and $type eq "orange") {
my $r = 190 + int(65 * $v1);
my $g = 90 + int(65 * $v1);
return "rgb($r,$g,0)";
}
return "rgb(0,0,0)";
}
sub color_scale {
my ($value, $max) = @_;
my ($r, $g, $b) = (255, 255, 255);
$value = -$value if $negate;
if ($value > 0) {
$g = $b = int(210 * ($max - $value) / $max);
} elsif ($value < 0) {
$r = $g = int(210 * ($max + $value) / $max);
}
return "rgb($r,$g,$b)";
}
sub color_map {
my ($colors, $func, $width) = @_;
if (exists $palette_map{$func}) {
return $palette_map{$func};
} else {
$palette_map{$func} = color($colors, $hash, $func, $width);
return $palette_map{$func};
}
}
sub write_palette {
open(FILE, ">$pal_file");
foreach my $key (sort keys %palette_map) {
print FILE $key."->".$palette_map{$key}."\n";
}
close(FILE);
}
sub read_palette {
if (-e $pal_file) {
open(FILE, $pal_file) or die "can't open file $pal_file: $!";
while ( my $line = <FILE>) {
chomp($line);
(my $key, my $value) = split("->",$line);
$palette_map{$key}=$value;
}
close(FILE)
}