This is an automated email from the ASF dual-hosted git repository.
morningman pushed a commit to branch branch-2.1
in repository https://gitbox.apache.org/repos/asf/doris.git
The following commit(s) were added to refs/heads/branch-2.1 by this push:
new 596cfc9b180 [opt](cpu-profile) enable cpu profile in BE webui (#40330)
(#41044)
596cfc9b180 is described below
commit 596cfc9b1809ad49bc245168ce6c0e3cdcda112f
Author: Mingyu Chen <[email protected]>
AuthorDate: Fri Sep 20 17:18:16 2024 +0800
[opt](cpu-profile) enable cpu profile in BE webui (#40330) (#41044)
bp #40330
---
.licenserc.yaml | 1 +
LICENSE.txt | 10 +-
be/src/http/action/pprof_actions.cpp | 14 +-
be/src/http/default_path_handlers.cpp | 21 +-
be/src/util/pprof_utils.cpp | 4 +
be/src/vec/exec/scan/vfile_scanner.cpp | 2 +-
be/src/vec/exec/scan/vfile_scanner.h | 2 +-
build.sh | 4 +-
dist/LICENSE-dist.txt | 65 +-
tools/FlameGraph/README | 13 +
tools/FlameGraph/flamegraph.pl | 1302 ++++++++++++++++++++++++++++++++
tools/FlameGraph/stackcollapse-perf.pl | 435 +++++++++++
12 files changed, 1821 insertions(+), 52 deletions(-)
diff --git a/.licenserc.yaml b/.licenserc.yaml
index 44fd6536b44..5b55745c91f 100644
--- a/.licenserc.yaml
+++ b/.licenserc.yaml
@@ -93,4 +93,5 @@ header:
- "pytest/sys/data"
- "pytest/deploy/*.conf"
- "tools/jeprof"
+ - "tools/FlameGraph/*"
comment: on-failure
diff --git a/LICENSE.txt b/LICENSE.txt
index e28911d07a4..6f9b2963bba 100644
--- a/LICENSE.txt
+++ b/LICENSE.txt
@@ -725,4 +725,12 @@ Apache 2.0, Copyright 2023 SAP SE or an SAP affiliate
company, Johannes Bechberg
This project is maintained by the SapMachine team at SAP SE
-----------------------------------------------------------------------------------
\ No newline at end of file
+----------------------------------------------------------------------------------
+
+be/tools/FlameGraph/*.pl: COMMON DEVELOPMENT AND DISTRIBUTION LICENSE Version
1.0
+
+Unless otherwise noted, all files in this distribution are released
+under the Common Development and Distribution License (CDDL).
+Exceptions are noted within the associated source files.
+
+----------------------------------------------------------------------------------
diff --git a/be/src/http/action/pprof_actions.cpp
b/be/src/http/action/pprof_actions.cpp
index 1cbe2163b93..22ea5ca79c9 100644
--- a/be/src/http/action/pprof_actions.cpp
+++ b/be/src/http/action/pprof_actions.cpp
@@ -17,9 +17,15 @@
#include "http/action/pprof_actions.h"
+#if !defined(__SANITIZE_ADDRESS__) && !defined(ADDRESS_SANITIZER) &&
!defined(LEAK_SANITIZER) && \
+ !defined(THREAD_SANITIZER) && !defined(USE_JEMALLOC)
#include <gperftools/heap-profiler.h> // IWYU pragma: keep
#include <gperftools/malloc_extension.h> // IWYU pragma: keep
-#include <gperftools/profiler.h> // IWYU pragma: keep
+#endif
+#if !defined(__SANITIZE_ADDRESS__) && !defined(ADDRESS_SANITIZER) &&
!defined(LEAK_SANITIZER) && \
+ !defined(THREAD_SANITIZER)
+#include <gperftools/profiler.h> // IWYU pragma: keep
+#endif
#include <stdio.h>
#include <fstream>
@@ -133,8 +139,7 @@ public:
};
void ProfileAction::handle(HttpRequest* req) {
-#if defined(ADDRESS_SANITIZER) || defined(LEAK_SANITIZER) ||
defined(THREAD_SANITIZER) || \
- defined(USE_JEMALLOC)
+#if defined(ADDRESS_SANITIZER) || defined(LEAK_SANITIZER) ||
defined(THREAD_SANITIZER)
std::string str = "CPU profiling is not available with address sanitizer
or jemalloc builds.";
HttpChannel::send_reply(req, str);
#else
@@ -170,6 +175,7 @@ void ProfileAction::handle(HttpRequest* req) {
prof_file.close();
std::string str = ss.str();
HttpChannel::send_reply(req, str);
+ return;
}
// text type. we will return readable content via http response
@@ -185,7 +191,7 @@ void ProfileAction::handle(HttpRequest* req) {
std::string svg_file_content;
std::string flamegraph_install_dir =
std::string(std::getenv("DORIS_HOME")) + "/tools/FlameGraph/";
- Status st = PprofUtils::generate_flamegraph(30,
flamegraph_install_dir, false,
+ Status st = PprofUtils::generate_flamegraph(seconds,
flamegraph_install_dir, false,
&svg_file_content);
if (!st.ok()) {
HttpChannel::send_reply(req, st.to_string());
diff --git a/be/src/http/default_path_handlers.cpp
b/be/src/http/default_path_handlers.cpp
index 8d1a14ffda3..30c35426f85 100644
--- a/be/src/http/default_path_handlers.cpp
+++ b/be/src/http/default_path_handlers.cpp
@@ -281,8 +281,7 @@ void heap_handler(const WebPageHandler::ArgumentMap& args,
std::stringstream* ou
void cpu_handler(const WebPageHandler::ArgumentMap& args, std::stringstream*
output) {
(*output) << "<h2>CPU Profile</h2>" << std::endl;
-#if defined(ADDRESS_SANITIZER) || defined(LEAK_SANITIZER) ||
defined(THREAD_SANITIZER) || \
- defined(USE_JEMALLOC)
+#if defined(ADDRESS_SANITIZER) || defined(LEAK_SANITIZER) ||
defined(THREAD_SANITIZER)
(*output) << "<pre>" << std::endl;
(*output) << "CPU profiling is not available with address sanitizer
builds." << std::endl;
(*output) << "</pre>" << std::endl;
@@ -313,7 +312,8 @@ void cpu_handler(const WebPageHandler::ArgumentMap& args,
std::stringstream* out
<< std::endl;
(*output) << "And you need to download the FlameGraph and place it under
'be/tools/FlameGraph'."
<< std::endl;
- (*output) << "Finally, check if the following files exist" << std::endl;
+ (*output) << "Finally, check if the following files exist. And should be
executable."
+ << std::endl;
(*output) << std::endl;
(*output) << " be/tools/FlameGraph/stackcollapse-perf.pl" << std::endl;
(*output) << " be/tools/FlameGraph/flamegraph.pl" << std::endl;
@@ -333,9 +333,6 @@ void cpu_handler(const WebPageHandler::ArgumentMap& args,
std::stringstream* out
<< std::endl;
(*output) << " <br/>" << std::endl;
(*output) << " <div id=\"cpuResult\"><pre
id=\"cpuContent\"></pre></div>" << std::endl;
- (*output) << " <br/>" << std::endl;
- (*output) << " <div id=\"cpuResultGraph\"><pre
id=\"cpuContentGraph\"></pre></div>"
- << std::endl;
(*output) << "</div>" << std::endl;
// for text profile
@@ -348,14 +345,14 @@ void cpu_handler(const WebPageHandler::ArgumentMap& args,
std::stringstream* out
(*output) << " type: \"GET\"," << std::endl;
(*output) << " dataType: \"text\"," << std::endl;
(*output) << " url: \"pprof/profile?type=text\"," << std::endl;
- (*output) << " timeout: 60000," << std::endl;
+ (*output) << " timeout: 120000," << std::endl;
(*output) << " success: function (result) {" << std::endl;
(*output) << "
document.getElementById(\"cpuContent\").innerText = result;"
<< std::endl;
(*output) << " }" << std::endl;
(*output) << " ," << std::endl;
(*output) << " error: function (result) {" << std::endl;
- (*output) << " alert(result);" << std::endl;
+ (*output) << " alert(JSON.stringify(result));" << std::endl;
(*output) << " }" << std::endl;
(*output) << " ," << std::endl;
(*output) << " });" << std::endl;
@@ -363,21 +360,21 @@ void cpu_handler(const WebPageHandler::ArgumentMap& args,
std::stringstream* out
// for graph profile
(*output) << "$('#getCpuGraph').click(function () {" << std::endl;
- (*output) << " document.getElementById(\"cpuContentGraph\").innerText =
\"Sampling... (30 "
+ (*output) << " document.getElementById(\"cpuContent\").innerText =
\"Sampling... (30 "
"seconds)\";"
<< std::endl;
(*output) << " $.ajax({" << std::endl;
(*output) << " type: \"GET\"," << std::endl;
(*output) << " dataType: \"text\"," << std::endl;
(*output) << " url: \"pprof/profile?type=flamegraph\"," <<
std::endl;
- (*output) << " timeout: 60000," << std::endl;
+ (*output) << " timeout: 120000," << std::endl;
(*output) << " success: function (result) {" << std::endl;
- (*output) << "
document.getElementById(\"cpuResultGraph\").innerHTML = result;"
+ (*output) << "
document.getElementById(\"cpuContent\").innerHTML = result;"
<< std::endl;
(*output) << " }" << std::endl;
(*output) << " ," << std::endl;
(*output) << " error: function (result) {" << std::endl;
- (*output) << " alert(result);" << std::endl;
+ (*output) << " alert(JSON.stringify(result));" << std::endl;
(*output) << " }" << std::endl;
(*output) << " ," << std::endl;
(*output) << " });" << std::endl;
diff --git a/be/src/util/pprof_utils.cpp b/be/src/util/pprof_utils.cpp
index c7f35ea299d..7ac50ee3397 100644
--- a/be/src/util/pprof_utils.cpp
+++ b/be/src/util/pprof_utils.cpp
@@ -114,6 +114,7 @@ Status PprofUtils::get_readable_profile(const std::string&
file_or_content, bool
std::string final_cmd =
pprof_cmd + strings::Substitute(" --text $0 $1", self_cmdline,
final_file);
AgentUtils util;
+ LOG(INFO) << "begin to run command: " << final_cmd;
bool rc = util.exec_cmd(final_cmd, &cmd_output, false);
// delete raw file
@@ -158,6 +159,7 @@ Status PprofUtils::generate_flamegraph(int32_t
sample_seconds,
AgentUtils util;
std::string cmd_output;
+ LOG(INFO) << "begin to run command: " << cmd.str();
bool rc = util.exec_cmd(cmd.str(), &cmd_output);
if (!rc) {
static_cast<void>(io::global_local_filesystem()->delete_file(tmp_file.str()));
@@ -174,6 +176,7 @@ Status PprofUtils::generate_flamegraph(int32_t
sample_seconds,
std::stringstream gen_cmd;
gen_cmd << perf_cmd << " script -i " << tmp_file.str() << " | " <<
stackcollapse_perf_pl
<< " | " << flamegraph_pl << " > " << graph_file.str();
+ LOG(INFO) << "begin to run command: " << gen_cmd.str();
rc = util.exec_cmd(gen_cmd.str(), &res_content);
if (!rc) {
static_cast<void>(io::global_local_filesystem()->delete_file(tmp_file.str()));
@@ -185,6 +188,7 @@ Status PprofUtils::generate_flamegraph(int32_t
sample_seconds,
std::stringstream gen_cmd;
gen_cmd << perf_cmd << " script -i " << tmp_file.str() << " | " <<
stackcollapse_perf_pl
<< " | " << flamegraph_pl;
+ LOG(INFO) << "begin to run command: " << gen_cmd.str();
rc = util.exec_cmd(gen_cmd.str(), &res_content, false);
if (!rc) {
static_cast<void>(io::global_local_filesystem()->delete_file(tmp_file.str()));
diff --git a/be/src/vec/exec/scan/vfile_scanner.cpp
b/be/src/vec/exec/scan/vfile_scanner.cpp
index 3a87a502ebe..d6191ea0d11 100644
--- a/be/src/vec/exec/scan/vfile_scanner.cpp
+++ b/be/src/vec/exec/scan/vfile_scanner.cpp
@@ -826,7 +826,7 @@ Status VFileScanner::_get_next_reader() {
std::unique_ptr<ParquetReader> parquet_reader =
ParquetReader::create_unique(
_profile, *_params, range,
_state->query_options().batch_size,
const_cast<cctz::time_zone*>(&_state->timezone_obj()),
_io_ctx.get(), _state,
- _shoudl_enable_file_meta_cache() ?
ExecEnv::GetInstance()->file_meta_cache()
+ _should_enable_file_meta_cache() ?
ExecEnv::GetInstance()->file_meta_cache()
: nullptr,
_state->query_options().enable_parquet_lazy_mat);
{
diff --git a/be/src/vec/exec/scan/vfile_scanner.h
b/be/src/vec/exec/scan/vfile_scanner.h
index 2c2116172c9..cf1ea97f21b 100644
--- a/be/src/vec/exec/scan/vfile_scanner.h
+++ b/be/src/vec/exec/scan/vfile_scanner.h
@@ -243,7 +243,7 @@ private:
// 1. max_external_file_meta_cache_num is > 0
// 2. the file number is less than 1/3 of cache's capacibility
// Otherwise, the cache miss rate will be high
- bool _shoudl_enable_file_meta_cache() {
+ bool _should_enable_file_meta_cache() {
return config::max_external_file_meta_cache_num > 0 &&
_split_source->num_scan_ranges() <
config::max_external_file_meta_cache_num / 3;
}
diff --git a/build.sh b/build.sh
index d8c7786531d..ada27d6d94f 100755
--- a/build.sh
+++ b/build.sh
@@ -666,7 +666,8 @@ if [[ "${OUTPUT_BE_BINARY}" -eq 1 ]]; then
install -d "${DORIS_OUTPUT}/be/bin" \
"${DORIS_OUTPUT}/be/conf" \
"${DORIS_OUTPUT}/be/lib" \
- "${DORIS_OUTPUT}/be/www"
+ "${DORIS_OUTPUT}/be/www" \
+ "${DORIS_OUTPUT}/be/tools/FlameGraph"
cp -r -p "${DORIS_HOME}/be/output/bin"/* "${DORIS_OUTPUT}/be/bin"/
cp -r -p "${DORIS_HOME}/be/output/conf"/* "${DORIS_OUTPUT}/be/conf"/
@@ -712,6 +713,7 @@ EOF
fi
cp -r -p "${DORIS_HOME}/webroot/be"/* "${DORIS_OUTPUT}/be/www"/
+ cp -r -p "${DORIS_HOME}/tools/FlameGraph"/*
"${DORIS_OUTPUT}/be/tools/FlameGraph"/
if [[ "${STRIP_DEBUG_INFO}" = "ON" ]]; then
cp -r -p "${DORIS_HOME}/be/output/lib/debug_info"
"${DORIS_OUTPUT}/be/lib"/
fi
diff --git a/dist/LICENSE-dist.txt b/dist/LICENSE-dist.txt
index d44f6bf4964..25cfe636d88 100644
--- a/dist/LICENSE-dist.txt
+++ b/dist/LICENSE-dist.txt
@@ -1503,35 +1503,36 @@ LGPL -- licenes/LICENSE-LGPL.txt
* gsasl: 1.10.0/1.8.0
Other dependencies:
- * libevent: 2.1.12 -- license/LICENSE-libevent.txt
- * openssl: 1.1.1s -- license/LICENSE-openssl.txt
- * gflag: 2.2.2 -- license/LICENSE-gflag.txt
- * glog: 0.4.0 -- license/LICENSE-glog.txt
- * gtest: 1.11.0 -- license/LICENSE-gtest.txt
- * snappy: 1.1.8 -- license/LICENSE-snappy.txt
- * gperftools: 2.9.1 -- license/LICENSE-gperftools.txt
- * zlib: 1.2.11 -- license/LICENSE-zlib.txt
- * lz4: 1.9.3 -- license/LICENSE-lz4.txt
- * bzip2: 1.0.8 -- license/LICENSE-bzip2.txt
- * rapidjson@1a803826 -- license/LICENSE-rapidjson.txt
- * curl: 7.79.0 -- license/LICENSE-curl.txt
- * re2: 2021-02-02 -- license/LICENSE-re2.txt
- * hyperscan: 5.4.0 -- license/LICENSE-hyperscan.txt
- * vectorscan: 5.4.7 -- license/LICENSE-vectorscan.txt
- * boost: 1.73.0 -- license/LICENSE-boost.txt
- * unixodbc: 2.3.7 -- license/LICENSE-unixodbc.txt
- * leveldb: 1.23 -- license/LICENSE-leveldb.txt
- * cyrus-sasl: 2.1.27 -- license/LICENSE-cyrus-sasl.txt
- * librdkafka: 1.8.2 -- license/LICENSE-librdkafka.txt
- * zstd: 1.5.2 -- license/LICENSE-zstd.txt
- * brotli: 1.0.9 -- license/LICENSE-brotli.txt
- * bitshuffle: 0.5.1 -- license/LICENSE-bigshuffle.txt
- * fmt: 7.1.3 -- license/LICENSE-fmt.txt
- * jemalloc: 5.3.0 -- license/LICENSE-jemolloc.txt
- * lzma@master -- license/LICENSE-lzma.txt
- * libdivide: 5.0 -- license/LICENSE-libdivide.txt
- * pdqsort: 0.0.0+git20180419 -- license/LICENSE-pdqsort.txt
- * breakpad@38ee0be -- license/LICENSE-breakpod.txt
- * xsimd: xmid@e9234cd6 -- license/LICENSE-xsimd.txt
- * xxhash: 0.8.1 -- license/LICENSE-xxhash.txt
- * concurrentqueue: 1.0.3 -- license/LICENSE-concurrentqueue.txt
+ * libevent: 2.1.12 -- licenses/LICENSE-libevent.txt
+ * openssl: 1.1.1s -- licenses/LICENSE-openssl.txt
+ * gflag: 2.2.2 -- licenses/LICENSE-gflag.txt
+ * glog: 0.4.0 -- licenses/LICENSE-glog.txt
+ * gtest: 1.11.0 -- licenses/LICENSE-gtest.txt
+ * snappy: 1.1.8 -- licenses/LICENSE-snappy.txt
+ * gperftools: 2.9.1 -- licenses/LICENSE-gperftools.txt
+ * zlib: 1.2.11 -- licenses/LICENSE-zlib.txt
+ * lz4: 1.9.3 -- licenses/LICENSE-lz4.txt
+ * bzip2: 1.0.8 -- licenses/LICENSE-bzip2.txt
+ * rapidjson@1a803826 -- licenses/LICENSE-rapidjson.txt
+ * curl: 7.79.0 -- licenses/LICENSE-curl.txt
+ * re2: 2021-02-02 -- licenses/LICENSE-re2.txt
+ * hyperscan: 5.4.0 -- licenses/LICENSE-hyperscan.txt
+ * vectorscan: 5.4.7 -- licenses/LICENSE-vectorscan.txt
+ * boost: 1.73.0 -- licenses/LICENSE-boost.txt
+ * unixodbc: 2.3.7 -- licenses/LICENSE-unixodbc.txt
+ * leveldb: 1.23 -- licenses/LICENSE-leveldb.txt
+ * cyrus-sasl: 2.1.27 -- licenses/LICENSE-cyrus-sasl.txt
+ * librdkafka: 1.8.2 -- licenses/LICENSE-librdkafka.txt
+ * zstd: 1.5.2 -- licenses/LICENSE-zstd.txt
+ * brotli: 1.0.9 -- licenses/LICENSE-brotli.txt
+ * bitshuffle: 0.5.1 -- licenses/LICENSE-bigshuffle.txt
+ * fmt: 7.1.3 -- licenses/LICENSE-fmt.txt
+ * jemalloc: 5.3.0 -- licenses/LICENSE-jemolloc.txt
+ * lzma@master -- licenses/LICENSE-lzma.txt
+ * libdivide: 5.0 -- licenses/LICENSE-libdivide.txt
+ * pdqsort: 0.0.0+git20180419 -- licenses/LICENSE-pdqsort.txt
+ * breakpad@38ee0be -- licenses/LICENSE-breakpod.txt
+ * xsimd: xmid@e9234cd6 -- licenses/LICENSE-xsimd.txt
+ * xxhash: 0.8.1 -- licenses/LICENSE-xxhash.txt
+ * concurrentqueue: 1.0.3 -- licenses/LICENSE-concurrentqueue.txt
+ * FlameGraph -- licenses/LICENSE-CDDL-1.0.txt
diff --git a/tools/FlameGraph/README b/tools/FlameGraph/README
new file mode 100644
index 00000000000..64d54ca645a
--- /dev/null
+++ b/tools/FlameGraph/README
@@ -0,0 +1,13 @@
+These 2 files:
+
+- flamegraph.pl
+- stackcollapse-perf.pl
+
+are copied from:
+
+https://github.com/brendangregg/FlameGraph/blob/master/flamegraph.pl
+https://github.com/brendangregg/FlameGraph/blob/master/stackcollapse-perf.pl
+
+which are under license:
+
+https://github.com/brendangregg/FlameGraph/blob/master/docs/cddl1.txt
diff --git a/tools/FlameGraph/flamegraph.pl b/tools/FlameGraph/flamegraph.pl
new file mode 100755
index 00000000000..8c917ecf323
--- /dev/null
+++ b/tools/FlameGraph/flamegraph.pl
@@ -0,0 +1,1302 @@
+#!/usr/bin/perl -w
+#
+# 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 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
+#
+# 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) = @_;
+ 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);
+ return "rgb($r,$x,$x)";
+ }
+ 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) = @_;
+ if (exists $palette_map{$func}) {
+ return $palette_map{$func};
+ } else {
+ $palette_map{$func} = color($colors, $hash, $func);
+ 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)
+ }
+}
+
+my %Node; # Hash of merged frame data
+my %Tmp;
+
+# flow() merges two stacks, storing the merged frames and value data in %Node.
+sub flow {
+ my ($last, $this, $v, $d) = @_;
+
+ my $len_a = @$last - 1;
+ my $len_b = @$this - 1;
+
+ my $i = 0;
+ my $len_same;
+ for (; $i <= $len_a; $i++) {
+ last if $i > $len_b;
+ last if $last->[$i] ne $this->[$i];
+ }
+ $len_same = $i;
+
+ for ($i = $len_a; $i >= $len_same; $i--) {
+ my $k = "$last->[$i];$i";
+ # a unique ID is constructed from "func;depth;etime";
+ # func-depth isn't unique, it may be repeated later.
+ $Node{"$k;$v"}->{stime} = delete $Tmp{$k}->{stime};
+ if (defined $Tmp{$k}->{delta}) {
+ $Node{"$k;$v"}->{delta} = delete $Tmp{$k}->{delta};
+ }
+ delete $Tmp{$k};
+ }
+
+ for ($i = $len_same; $i <= $len_b; $i++) {
+ my $k = "$this->[$i];$i";
+ $Tmp{$k}->{stime} = $v;
+ if (defined $d) {
+ $Tmp{$k}->{delta} += $i == $len_b ? $d : 0;
+ }
+ }
+
+ return $this;
+}
+
+# parse input
+my @Data;
+my @SortedData;
+my $last = [];
+my $time = 0;
+my $delta = undef;
+my $ignored = 0;
+my $line;
+my $maxdelta = 1;
+
+# reverse if needed
+foreach (<>) {
+ chomp;
+ $line = $_;
+ if ($stackreverse) {
+ # there may be an extra samples column for differentials
+ # XXX todo: redo these REs as one. It's repeated below.
+ my($stack, $samples) = (/^(.*)\s+?(\d+(?:\.\d*)?)$/);
+ my $samples2 = undef;
+ if ($stack =~ /^(.*)\s+?(\d+(?:\.\d*)?)$/) {
+ $samples2 = $samples;
+ ($stack, $samples) = $stack =~
(/^(.*)\s+?(\d+(?:\.\d*)?)$/);
+ unshift @Data, join(";", reverse split(";", $stack)) .
" $samples $samples2";
+ } else {
+ unshift @Data, join(";", reverse split(";", $stack)) .
" $samples";
+ }
+ } else {
+ unshift @Data, $line;
+ }
+}
+
+if ($flamechart) {
+ # In flame chart mode, just reverse the data so time moves from left to
right.
+ @SortedData = reverse @Data;
+} else {
+ @SortedData = sort @Data;
+}
+
+# process and merge frames
+foreach (@SortedData) {
+ chomp;
+ # process: folded_stack count
+ # eg: func_a;func_b;func_c 31
+ my ($stack, $samples) = (/^(.*)\s+?(\d+(?:\.\d*)?)$/);
+ unless (defined $samples and defined $stack) {
+ ++$ignored;
+ next;
+ }
+
+ # there may be an extra samples column for differentials:
+ my $samples2 = undef;
+ if ($stack =~ /^(.*)\s+?(\d+(?:\.\d*)?)$/) {
+ $samples2 = $samples;
+ ($stack, $samples) = $stack =~ (/^(.*)\s+?(\d+(?:\.\d*)?)$/);
+ }
+ $delta = undef;
+ if (defined $samples2) {
+ $delta = $samples2 - $samples;
+ $maxdelta = abs($delta) if abs($delta) > $maxdelta;
+ }
+
+ # for chain graphs, annotate waker frames with "_[w]", for later
+ # coloring. This is a hack, but has a precedent ("_[k]" from perf).
+ if ($colors eq "chain") {
+ my @parts = split ";--;", $stack;
+ my @newparts = ();
+ $stack = shift @parts;
+ $stack .= ";--;";
+ foreach my $part (@parts) {
+ $part =~ s/;/_[w];/g;
+ $part .= "_[w]";
+ push @newparts, $part;
+ }
+ $stack .= join ";--;", @parts;
+ }
+
+ # merge frames and populate %Node:
+ $last = flow($last, [ '', split ";", $stack ], $time, $delta);
+
+ if (defined $samples2) {
+ $time += $samples2;
+ } else {
+ $time += $samples;
+ }
+}
+flow($last, [], $time, $delta);
+
+if ($countname eq "samples") {
+ # If $countname is used, it's likely that we're not measuring in stack
samples
+ # (e.g. time could be the unit), so don't warn.
+ warn "Stack count is low ($time). Did something go wrong?\n" if $time <
100;
+}
+
+warn "Ignored $ignored lines with invalid format\n" if $ignored;
+unless ($time) {
+ warn "ERROR: No stack counts found\n";
+ my $im = SVG->new();
+ # emit an error message SVG, for tools automating flamegraph use
+ my $imageheight = $fontsize * 5;
+ $im->header($imagewidth, $imageheight);
+ $im->stringTTF(undef, int($imagewidth / 2), $fontsize * 2,
+ "ERROR: No valid input provided to flamegraph.pl.");
+ print $im->svg;
+ exit 2;
+}
+if ($timemax and $timemax < $time) {
+ warn "Specified --total $timemax is less than actual total $time, so
ignored\n"
+ if $timemax/$time > 0.02; # only warn is significant (e.g., not
rounding etc)
+ undef $timemax;
+}
+$timemax ||= $time;
+
+my $widthpertime = ($imagewidth - 2 * $xpad) / $timemax;
+
+# Treat as a percentage of time if the string ends in a "%".
+my $minwidth_time;
+if ($minwidth =~ /%$/) {
+ $minwidth_time = $timemax * $minwidth_f / 100;
+} else {
+ $minwidth_time = $minwidth_f / $widthpertime;
+}
+
+# prune blocks that are too narrow and determine max depth
+while (my ($id, $node) = each %Node) {
+ my ($func, $depth, $etime) = split ";", $id;
+ my $stime = $node->{stime};
+ die "missing start for $id" if not defined $stime;
+
+ if (($etime-$stime) < $minwidth_time) {
+ delete $Node{$id};
+ next;
+ }
+ $depthmax = $depth if $depth > $depthmax;
+}
+
+# draw canvas, and embed interactive JavaScript program
+my $imageheight = (($depthmax + 1) * $frameheight) + $ypad1 + $ypad2;
+$imageheight += $ypad3 if $subtitletext ne "";
+my $titlesize = $fontsize + 5;
+my $im = SVG->new();
+my ($black, $vdgrey, $dgrey) = (
+ $im->colorAllocate(0, 0, 0),
+ $im->colorAllocate(160, 160, 160),
+ $im->colorAllocate(200, 200, 200),
+ );
+$im->header($imagewidth, $imageheight);
+my $inc = <<INC;
+<defs>
+ <linearGradient id="background" y1="0" y2="1" x1="0" x2="0" >
+ <stop stop-color="$bgcolor1" offset="5%" />
+ <stop stop-color="$bgcolor2" offset="95%" />
+ </linearGradient>
+</defs>
+<style type="text/css">
+ text { font-family:$fonttype; font-size:${fontsize}px; fill:$black; }
+ #search, #ignorecase { opacity:0.1; cursor:pointer; }
+ #search:hover, #search.show, #ignorecase:hover, #ignorecase.show {
opacity:1; }
+ #subtitle { text-anchor:middle; font-color:$vdgrey; }
+ #title { text-anchor:middle; font-size:${titlesize}px}
+ #unzoom { cursor:pointer; }
+ #frames > *:hover { stroke:black; stroke-width:0.5; cursor:pointer; }
+ .hide { display:none; }
+ .parent { opacity:0.5; }
+</style>
+<script type="text/ecmascript">
+<![CDATA[
+ "use strict";
+ var details, searchbtn, unzoombtn, matchedtxt, svg, searching,
currentSearchTerm, ignorecase, ignorecaseBtn;
+ function init(evt) {
+ details = document.getElementById("details").firstChild;
+ searchbtn = document.getElementById("search");
+ ignorecaseBtn = document.getElementById("ignorecase");
+ unzoombtn = document.getElementById("unzoom");
+ matchedtxt = document.getElementById("matched");
+ svg = document.getElementsByTagName("svg")[0];
+ searching = 0;
+ currentSearchTerm = null;
+
+ // use GET parameters to restore a flamegraphs state.
+ var params = get_params();
+ if (params.x && params.y)
+ zoom(find_group(document.querySelector('[x="' +
params.x + '"][y="' + params.y + '"]')));
+ if (params.s) search(params.s);
+ }
+
+ // event listeners
+ window.addEventListener("click", function(e) {
+ var target = find_group(e.target);
+ if (target) {
+ if (target.nodeName == "a") {
+ if (e.ctrlKey === false) return;
+ e.preventDefault();
+ }
+ if (target.classList.contains("parent")) unzoom(true);
+ zoom(target);
+ if (!document.querySelector('.parent')) {
+ // we have basically done a clearzoom so clear
the url
+ var params = get_params();
+ if (params.x) delete params.x;
+ if (params.y) delete params.y;
+ history.replaceState(null, null,
parse_params(params));
+ unzoombtn.classList.add("hide");
+ return;
+ }
+
+ // set parameters for zoom state
+ var el = target.querySelector("rect");
+ if (el && el.attributes && el.attributes.y &&
el.attributes._orig_x) {
+ var params = get_params()
+ params.x = el.attributes._orig_x.value;
+ params.y = el.attributes.y.value;
+ history.replaceState(null, null,
parse_params(params));
+ }
+ }
+ else if (e.target.id == "unzoom") clearzoom();
+ else if (e.target.id == "search") search_prompt();
+ else if (e.target.id == "ignorecase") toggle_ignorecase();
+ }, false)
+
+ // mouse-over for info
+ // show
+ window.addEventListener("mouseover", function(e) {
+ var target = find_group(e.target);
+ if (target) details.nodeValue = "$nametype " +
g_to_text(target);
+ }, false)
+
+ // clear
+ window.addEventListener("mouseout", function(e) {
+ var target = find_group(e.target);
+ if (target) details.nodeValue = ' ';
+ }, false)
+
+ // ctrl-F for search
+ // ctrl-I to toggle case-sensitive search
+ window.addEventListener("keydown",function (e) {
+ if (e.keyCode === 114 || (e.ctrlKey && e.keyCode === 70)) {
+ e.preventDefault();
+ search_prompt();
+ }
+ else if (e.ctrlKey && e.keyCode === 73) {
+ e.preventDefault();
+ toggle_ignorecase();
+ }
+ }, false)
+
+ // functions
+ function get_params() {
+ var params = {};
+ var paramsarr = window.location.search.substr(1).split('&');
+ for (var i = 0; i < paramsarr.length; ++i) {
+ var tmp = paramsarr[i].split("=");
+ if (!tmp[0] || !tmp[1]) continue;
+ params[tmp[0]] = decodeURIComponent(tmp[1]);
+ }
+ return params;
+ }
+ function parse_params(params) {
+ var uri = "?";
+ for (var key in params) {
+ uri += key + '=' + encodeURIComponent(params[key]) +
'&';
+ }
+ if (uri.slice(-1) == "&")
+ uri = uri.substring(0, uri.length - 1);
+ if (uri == '?')
+ uri = window.location.href.split('?')[0];
+ return uri;
+ }
+ function find_child(node, selector) {
+ var children = node.querySelectorAll(selector);
+ if (children.length) return children[0];
+ }
+ function find_group(node) {
+ var parent = node.parentElement;
+ if (!parent) return;
+ if (parent.id == "frames") return node;
+ return find_group(parent);
+ }
+ function orig_save(e, attr, val) {
+ if (e.attributes["_orig_" + attr] != undefined) return;
+ if (e.attributes[attr] == undefined) return;
+ if (val == undefined) val = e.attributes[attr].value;
+ e.setAttribute("_orig_" + attr, val);
+ }
+ function orig_load(e, attr) {
+ if (e.attributes["_orig_"+attr] == undefined) return;
+ e.attributes[attr].value = e.attributes["_orig_" + attr].value;
+ e.removeAttribute("_orig_"+attr);
+ }
+ function g_to_text(e) {
+ var text = find_child(e, "title").firstChild.nodeValue;
+ return (text)
+ }
+ function g_to_func(e) {
+ var func = g_to_text(e);
+ // if there's any manipulation we want to do to the function
+ // name before it's searched, do it here before returning.
+ return (func);
+ }
+ function update_text(e) {
+ var r = find_child(e, "rect");
+ var t = find_child(e, "text");
+ var w = parseFloat(r.attributes.width.value) -3;
+ var txt = find_child(e,
"title").textContent.replace(/\\([^(]*\\)\$/,"");
+ t.attributes.x.value = parseFloat(r.attributes.x.value) + 3;
+
+ // Smaller than this size won't fit anything
+ if (w < 2 * $fontsize * $fontwidth) {
+ t.textContent = "";
+ return;
+ }
+
+ t.textContent = txt;
+ var sl = t.getSubStringLength(0, txt.length);
+ // check if only whitespace or if we can fit the entire string
into width w
+ if (/^ *\$/.test(txt) || sl < w)
+ return;
+
+ // this isn't perfect, but gives a good starting point
+ // and avoids calling getSubStringLength too often
+ var start = Math.floor((w/sl) * txt.length);
+ for (var x = start; x > 0; x = x-2) {
+ if (t.getSubStringLength(0, x + 2) <= w) {
+ t.textContent = txt.substring(0, x) + "..";
+ return;
+ }
+ }
+ t.textContent = "";
+ }
+
+ // zoom
+ function zoom_reset(e) {
+ if (e.attributes != undefined) {
+ orig_load(e, "x");
+ orig_load(e, "width");
+ }
+ if (e.childNodes == undefined) return;
+ for (var i = 0, c = e.childNodes; i < c.length; i++) {
+ zoom_reset(c[i]);
+ }
+ }
+ function zoom_child(e, x, ratio) {
+ if (e.attributes != undefined) {
+ if (e.attributes.x != undefined) {
+ orig_save(e, "x");
+ e.attributes.x.value =
(parseFloat(e.attributes.x.value) - x - $xpad) * ratio + $xpad;
+ if (e.tagName == "text")
+ e.attributes.x.value =
find_child(e.parentNode, "rect[x]").attributes.x.value + 3;
+ }
+ if (e.attributes.width != undefined) {
+ orig_save(e, "width");
+ e.attributes.width.value =
parseFloat(e.attributes.width.value) * ratio;
+ }
+ }
+
+ if (e.childNodes == undefined) return;
+ for (var i = 0, c = e.childNodes; i < c.length; i++) {
+ zoom_child(c[i], x - $xpad, ratio);
+ }
+ }
+ function zoom_parent(e) {
+ if (e.attributes) {
+ if (e.attributes.x != undefined) {
+ orig_save(e, "x");
+ e.attributes.x.value = $xpad;
+ }
+ if (e.attributes.width != undefined) {
+ orig_save(e, "width");
+ e.attributes.width.value =
parseInt(svg.width.baseVal.value) - ($xpad * 2);
+ }
+ }
+ if (e.childNodes == undefined) return;
+ for (var i = 0, c = e.childNodes; i < c.length; i++) {
+ zoom_parent(c[i]);
+ }
+ }
+ function zoom(node) {
+ var attr = find_child(node, "rect").attributes;
+ var width = parseFloat(attr.width.value);
+ var xmin = parseFloat(attr.x.value);
+ var xmax = parseFloat(xmin + width);
+ var ymin = parseFloat(attr.y.value);
+ var ratio = (svg.width.baseVal.value - 2 * $xpad) / width;
+
+ // XXX: Workaround for JavaScript float issues (fix me)
+ var fudge = 0.0001;
+
+ unzoombtn.classList.remove("hide");
+
+ var el = document.getElementById("frames").children;
+ for (var i = 0; i < el.length; i++) {
+ var e = el[i];
+ var a = find_child(e, "rect").attributes;
+ var ex = parseFloat(a.x.value);
+ var ew = parseFloat(a.width.value);
+ var upstack;
+ // Is it an ancestor
+ if ($inverted == 0) {
+ upstack = parseFloat(a.y.value) > ymin;
+ } else {
+ upstack = parseFloat(a.y.value) < ymin;
+ }
+ if (upstack) {
+ // Direct ancestor
+ if (ex <= xmin && (ex+ew+fudge) >= xmax) {
+ e.classList.add("parent");
+ zoom_parent(e);
+ update_text(e);
+ }
+ // not in current path
+ else
+ e.classList.add("hide");
+ }
+ // Children maybe
+ else {
+ // no common path
+ if (ex < xmin || ex + fudge >= xmax) {
+ e.classList.add("hide");
+ }
+ else {
+ zoom_child(e, xmin, ratio);
+ update_text(e);
+ }
+ }
+ }
+ search();
+ }
+ function unzoom(dont_update_text) {
+ unzoombtn.classList.add("hide");
+ var el = document.getElementById("frames").children;
+ for(var i = 0; i < el.length; i++) {
+ el[i].classList.remove("parent");
+ el[i].classList.remove("hide");
+ zoom_reset(el[i]);
+ if(!dont_update_text) update_text(el[i]);
+ }
+ search();
+ }
+ function clearzoom() {
+ unzoom();
+
+ // remove zoom state
+ var params = get_params();
+ if (params.x) delete params.x;
+ if (params.y) delete params.y;
+ history.replaceState(null, null, parse_params(params));
+ }
+
+ // search
+ function toggle_ignorecase() {
+ ignorecase = !ignorecase;
+ if (ignorecase) {
+ ignorecaseBtn.classList.add("show");
+ } else {
+ ignorecaseBtn.classList.remove("show");
+ }
+ reset_search();
+ search();
+ }
+ function reset_search() {
+ var el = document.querySelectorAll("#frames rect");
+ for (var i = 0; i < el.length; i++) {
+ orig_load(el[i], "fill")
+ }
+ var params = get_params();
+ delete params.s;
+ history.replaceState(null, null, parse_params(params));
+ }
+ function search_prompt() {
+ if (!searching) {
+ var term = prompt("Enter a search term (regexp " +
+ "allowed, eg: ^ext4_)"
+ + (ignorecase ? ", ignoring case" : "")
+ + "\\nPress Ctrl-i to toggle case sensitivity", "");
+ if (term != null) search(term);
+ } else {
+ reset_search();
+ searching = 0;
+ currentSearchTerm = null;
+ searchbtn.classList.remove("show");
+ searchbtn.firstChild.nodeValue = "Search"
+ matchedtxt.classList.add("hide");
+ matchedtxt.firstChild.nodeValue = ""
+ }
+ }
+ function search(term) {
+ if (term) currentSearchTerm = term;
+
+ var re = new RegExp(currentSearchTerm, ignorecase ? 'i' : '');
+ var el = document.getElementById("frames").children;
+ var matches = new Object();
+ var maxwidth = 0;
+ for (var i = 0; i < el.length; i++) {
+ var e = el[i];
+ var func = g_to_func(e);
+ var rect = find_child(e, "rect");
+ if (func == null || rect == null)
+ continue;
+
+ // Save max width. Only works as we have a root frame
+ var w = parseFloat(rect.attributes.width.value);
+ if (w > maxwidth)
+ maxwidth = w;
+
+ if (func.match(re)) {
+ // highlight
+ var x = parseFloat(rect.attributes.x.value);
+ orig_save(rect, "fill");
+ rect.attributes.fill.value = "$searchcolor";
+
+ // remember matches
+ if (matches[x] == undefined) {
+ matches[x] = w;
+ } else {
+ if (w > matches[x]) {
+ // overwrite with parent
+ matches[x] = w;
+ }
+ }
+ searching = 1;
+ }
+ }
+ if (!searching)
+ return;
+ var params = get_params();
+ params.s = currentSearchTerm;
+ history.replaceState(null, null, parse_params(params));
+
+ searchbtn.classList.add("show");
+ searchbtn.firstChild.nodeValue = "Reset Search";
+
+ // calculate percent matched, excluding vertical overlap
+ var count = 0;
+ var lastx = -1;
+ var lastw = 0;
+ var keys = Array();
+ for (k in matches) {
+ if (matches.hasOwnProperty(k))
+ keys.push(k);
+ }
+ // sort the matched frames by their x location
+ // ascending, then width descending
+ keys.sort(function(a, b){
+ return a - b;
+ });
+ // Step through frames saving only the biggest bottom-up frames
+ // thanks to the sort order. This relies on the tree property
+ // where children are always smaller than their parents.
+ var fudge = 0.0001; // JavaScript floating point
+ for (var k in keys) {
+ var x = parseFloat(keys[k]);
+ var w = matches[keys[k]];
+ if (x >= lastx + lastw - fudge) {
+ count += w;
+ lastx = x;
+ lastw = w;
+ }
+ }
+ // display matched percent
+ matchedtxt.classList.remove("hide");
+ var pct = 100 * count / maxwidth;
+ if (pct != 100) pct = pct.toFixed(1)
+ matchedtxt.firstChild.nodeValue = "Matched: " + pct + "%";
+ }
+]]>
+</script>
+INC
+$im->include($inc);
+$im->filledRectangle(0, 0, $imagewidth, $imageheight, 'url(#background)');
+$im->stringTTF("title", int($imagewidth / 2), $fontsize * 2, $titletext);
+$im->stringTTF("subtitle", int($imagewidth / 2), $fontsize * 4, $subtitletext)
if $subtitletext ne "";
+$im->stringTTF("details", $xpad, $imageheight - ($ypad2 / 2), " ");
+$im->stringTTF("unzoom", $xpad, $fontsize * 2, "Reset Zoom", 'class="hide"');
+$im->stringTTF("search", $imagewidth - $xpad - 100, $fontsize * 2, "Search");
+$im->stringTTF("ignorecase", $imagewidth - $xpad - 16, $fontsize * 2, "ic");
+$im->stringTTF("matched", $imagewidth - $xpad - 100, $imageheight - ($ypad2 /
2), " ");
+
+if ($palette) {
+ read_palette();
+}
+
+# draw frames
+$im->group_start({id => "frames"});
+while (my ($id, $node) = each %Node) {
+ my ($func, $depth, $etime) = split ";", $id;
+ my $stime = $node->{stime};
+ my $delta = $node->{delta};
+
+ $etime = $timemax if $func eq "" and $depth == 0;
+
+ my $x1 = $xpad + $stime * $widthpertime;
+ my $x2 = $xpad + $etime * $widthpertime;
+ my ($y1, $y2);
+ unless ($inverted) {
+ $y1 = $imageheight - $ypad2 - ($depth + 1) * $frameheight +
$framepad;
+ $y2 = $imageheight - $ypad2 - $depth * $frameheight;
+ } else {
+ $y1 = $ypad1 + $depth * $frameheight;
+ $y2 = $ypad1 + ($depth + 1) * $frameheight - $framepad;
+ }
+
+ # Add commas per perlfaq5:
+ #
https://perldoc.perl.org/perlfaq5#How-can-I-output-my-numbers-with-commas-added?
+ my $samples = sprintf "%.0f", ($etime - $stime) * $factor;
+ (my $samples_txt = $samples)
+ =~ s/(^[-+]?\d+?(?=(?>(?:\d{3})+)(?!\d))|\G\d{3}(?=\d))/$1,/g;
+
+ my $info;
+ if ($func eq "" and $depth == 0) {
+ $info = "all ($samples_txt $countname, 100%)";
+ } else {
+ my $pct = sprintf "%.2f", ((100 * $samples) / ($timemax *
$factor));
+ my $escaped_func = $func;
+ # clean up SVG breaking characters:
+ $escaped_func =~ s/&/&/g;
+ $escaped_func =~ s/</</g;
+ $escaped_func =~ s/>/>/g;
+ $escaped_func =~ s/"/"/g;
+ $escaped_func =~ s/_\[[kwij]\]$//; # strip any annotation
+ unless (defined $delta) {
+ $info = "$escaped_func ($samples_txt $countname,
$pct%)";
+ } else {
+ my $d = $negate ? -$delta : $delta;
+ my $deltapct = sprintf "%.2f", ((100 * $d) / ($timemax
* $factor));
+ $deltapct = $d > 0 ? "+$deltapct" : $deltapct;
+ $info = "$escaped_func ($samples_txt $countname, $pct%;
$deltapct%)";
+ }
+ }
+
+ my $nameattr = { %{ $nameattr{$func}||{} } }; # shallow clone
+ $nameattr->{title} ||= $info;
+ $im->group_start($nameattr);
+
+ my $color;
+ if ($func eq "--") {
+ $color = $vdgrey;
+ } elsif ($func eq "-") {
+ $color = $dgrey;
+ } elsif (defined $delta) {
+ $color = color_scale($delta, $maxdelta);
+ } elsif ($palette) {
+ $color = color_map($colors, $func);
+ } else {
+ $color = color($colors, $hash, $func);
+ }
+ $im->filledRectangle($x1, $y1, $x2, $y2, $color, 'rx="2" ry="2"');
+
+ my $chars = int( ($x2 - $x1) / ($fontsize * $fontwidth));
+ my $text = "";
+ if ($chars >= 3) { # room for one char plus two dots
+ $func =~ s/_\[[kwij]\]$//; # strip any annotation
+ $text = substr $func, 0, $chars;
+ substr($text, -2, 2) = ".." if $chars < length $func;
+ $text =~ s/&/&/g;
+ $text =~ s/</</g;
+ $text =~ s/>/>/g;
+ }
+ $im->stringTTF(undef, $x1 + 3, 3 + ($y1 + $y2) / 2, $text);
+
+ $im->group_end($nameattr);
+}
+$im->group_end();
+
+print $im->svg;
+
+if ($palette) {
+ write_palette();
+}
+
+# vim: ts=8 sts=8 sw=8 noexpandtab
diff --git a/tools/FlameGraph/stackcollapse-perf.pl
b/tools/FlameGraph/stackcollapse-perf.pl
new file mode 100755
index 00000000000..3ff39bfb87f
--- /dev/null
+++ b/tools/FlameGraph/stackcollapse-perf.pl
@@ -0,0 +1,435 @@
+#!/usr/bin/perl -w
+#
+# stackcollapse-perf.pl collapse perf samples into single lines.
+#
+# Parses a list of multiline stacks generated by "perf script", and
+# outputs a semicolon separated stack followed by a space and a count.
+# If memory addresses (+0xd) are present, they are stripped, and resulting
+# identical stacks are colased with their counts summed.
+#
+# USAGE: ./stackcollapse-perf.pl [options] infile > outfile
+#
+# Run "./stackcollapse-perf.pl -h" to list options.
+#
+# Example input:
+#
+# swapper 0 [000] 158665.570607: cpu-clock:
+# ffffffff8103ce3b native_safe_halt ([kernel.kallsyms])
+# ffffffff8101c6a3 default_idle ([kernel.kallsyms])
+# ffffffff81013236 cpu_idle ([kernel.kallsyms])
+# ffffffff815bf03e rest_init ([kernel.kallsyms])
+# ffffffff81aebbfe start_kernel ([kernel.kallsyms].init.text)
+# [...]
+#
+# Example output:
+#
+# swapper;start_kernel;rest_init;cpu_idle;default_idle;native_safe_halt 1
+#
+# Input may be created and processed using:
+#
+# perf record -a -g -F 997 sleep 60
+# perf script | ./stackcollapse-perf.pl > out.stacks-folded
+#
+# The output of "perf script" should include stack traces. If these are missing
+# for you, try manually selecting the perf script output; eg:
+#
+# perf script -f comm,pid,tid,cpu,time,event,ip,sym,dso,trace | ...
+#
+# This is also required for the --pid or --tid options, so that the output has
+# both the PID and TID.
+#
+# Copyright 2012 Joyent, Inc. All rights reserved.
+# Copyright 2012 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
+#
+# 02-Mar-2012 Brendan Gregg Created this.
+# 02-Jul-2014 " " Added process name to stacks.
+
+use strict;
+use Getopt::Long;
+
+my %collapsed;
+
+sub remember_stack {
+ my ($stack, $count) = @_;
+ $collapsed{$stack} += $count;
+}
+my $annotate_kernel = 0; # put an annotation on kernel function
+my $annotate_jit = 0; # put an annotation on jit symbols
+my $annotate_all = 0; # enale all annotations
+my $include_pname = 1; # include process names in stacks
+my $include_pid = 0; # include process ID with process name
+my $include_tid = 0; # include process & thread ID with process name
+my $include_addrs = 0; # include raw address where a symbol can't be found
+my $tidy_java = 1; # condense Java signatures
+my $tidy_generic = 1; # clean up function names a little
+my $target_pname; # target process name from perf invocation
+my $event_filter = ""; # event type filter, defaults to first encountered
event
+my $event_defaulted = 0; # whether we defaulted to an event (none provided)
+my $event_warning = 0; # if we printed a warning for the event
+
+my $show_inline = 0;
+my $show_context = 0;
+
+my $srcline_in_input = 0; # if there are extra lines with source location
(perf script -F+srcline)
+GetOptions('inline' => \$show_inline,
+ 'context' => \$show_context,
+ 'srcline' => \$srcline_in_input,
+ 'pid' => \$include_pid,
+ 'kernel' => \$annotate_kernel,
+ 'jit' => \$annotate_jit,
+ 'all' => \$annotate_all,
+ 'tid' => \$include_tid,
+ 'addrs' => \$include_addrs,
+ 'event-filter=s' => \$event_filter)
+or die <<USAGE_END;
+USAGE: $0 [options] infile > outfile\n
+ --pid # include PID with process names [1]
+ --tid # include TID and PID with process names [1]
+ --inline # un-inline using addr2line
+ --all # all annotations (--kernel --jit)
+ --kernel # annotate kernel functions with a _[k]
+ --jit # annotate jit functions with a _[j]
+ --context # adds source context to --inline
+ --srcline # parses output of 'perf script -F+srcline' and adds
source context
+ --addrs # include raw addresses where symbols can't be found
+ --event-filter=EVENT # event name filter\n
+[1] perf script must emit both PID and TIDs for these to work; eg, Linux < 4.1:
+ perf script -f comm,pid,tid,cpu,time,event,ip,sym,dso,trace
+ for Linux >= 4.1:
+ perf script -F comm,pid,tid,cpu,time,event,ip,sym,dso,trace
+ If you save this output add --header on Linux >= 3.14 to include perf info.
+USAGE_END
+
+if ($annotate_all) {
+ $annotate_kernel = $annotate_jit = 1;
+}
+
+my %inlineCache;
+
+my %nmCache;
+
+sub inlineCacheAdd {
+ my ($pc, $mod, $result) = @_;
+ if (defined($inlineCache{$pc})) {
+ $inlineCache{$pc}{$mod} = $result;
+ } else {
+ $inlineCache{$pc} = {$mod => $result};
+ }
+}
+
+# for the --inline option
+sub inline {
+ my ($pc, $rawfunc, $mod) = @_;
+
+ return $inlineCache{$pc}{$mod} if defined($inlineCache{$pc}{$mod});
+
+ # capture addr2line output
+ my $a2l_output = `addr2line -a $pc -e $mod -i -f -s -C`;
+
+ # remove first line
+ $a2l_output =~ s/^(.*\n){1}//;
+
+ if ($a2l_output =~ /\?\?\n\?\?:0/) {
+ # if addr2line fails and rawfunc is func+offset, then fall back
to it
+ if ($rawfunc =~ /^(.+)\+0x([0-9a-f]+)$/) {
+ my $func = $1;
+ my $addr = hex $2;
+
+ $nmCache{$mod}=`nm $mod` unless defined $nmCache{$mod};
+
+ if ($nmCache{$mod} =~ /^([0-9a-f]+) . \Q$func\E$/m) {
+ my $base = hex $1;
+ my $newPc = sprintf "0x%x", $base+$addr;
+ my $result = inline($newPc, '', $mod);
+ inlineCacheAdd($pc, $mod, $result);
+ return $result;
+ }
+ }
+ }
+
+ my @fullfunc;
+ my $one_item = "";
+ for (split /^/, $a2l_output) {
+ chomp $_;
+
+ # remove discriminator info if exists
+ $_ =~ s/ \(discriminator \S+\)//;
+
+ if ($one_item eq "") {
+ $one_item = $_;
+ } else {
+ if ($show_context == 1) {
+ unshift @fullfunc, $one_item . ":$_";
+ } else {
+ unshift @fullfunc, $one_item;
+ }
+ $one_item = "";
+ }
+ }
+
+ my $result = join ";" , @fullfunc;
+
+ inlineCacheAdd($pc, $mod, $result);
+
+ return $result;
+}
+
+my @stack;
+my $pname;
+my $m_pid;
+my $m_tid;
+my $m_period;
+
+#
+# Main loop
+#
+while (defined($_ = <>)) {
+
+ # find the name of the process launched by perf, by stepping backwards
+ # over the args to find the first non-option (no dash):
+ if (/^# cmdline/) {
+ my @args = split ' ', $_;
+ foreach my $arg (reverse @args) {
+ if ($arg !~ /^-/) {
+ $target_pname = $arg;
+ $target_pname =~ s:.*/::; # strip pathname
+ last;
+ }
+ }
+ }
+
+ # skip remaining comments
+ next if m/^#/;
+ chomp;
+
+ # end of stack. save cached data.
+ if (m/^$/) {
+ # ignore filtered samples
+ next if not $pname;
+
+ if ($include_pname) {
+ if (defined $pname) {
+ unshift @stack, $pname;
+ } else {
+ unshift @stack, "";
+ }
+ }
+ remember_stack(join(";", @stack), $m_period) if @stack;
+ undef @stack;
+ undef $pname;
+ next;
+ }
+
+ #
+ # event record start
+ #
+ if (/^(\S.+?)\s+(\d+)\/*(\d+)*\s+/) {
+ # default "perf script" output has TID but not PID
+ # eg, "java 25607 4794564.109216: 1 cycles:"
+ # eg, "java 12688 [002] 6544038.708352: 235 cpu-clock:"
+ # eg, "V8 WorkerThread 25607 4794564.109216: 104345 cycles:"
+ # eg, "java 24636/25607 [000] 4794564.109216: 1 cycles:"
+ # eg, "java 12688/12764 6544038.708352: 10309278 cpu-clock:"
+ # eg, "V8 WorkerThread 24636/25607 [000] 94564.109216: 100
cycles:"
+ # other combinations possible
+ my ($comm, $pid, $tid, $period) = ($1, $2, $3, "");
+ if (not $tid) {
+ $tid = $pid;
+ $pid = "?";
+ }
+
+ if (/:\s*(\d+)*\s+(\S+):\s*$/) {
+ $period = $1;
+ my $event = $2;
+
+ if ($event_filter eq "") {
+ # By default only show events of the first
encountered
+ # event type. Merging together different types,
such as
+ # instructions and cycles, produces misleading
results.
+ $event_filter = $event;
+ $event_defaulted = 1;
+ } elsif ($event ne $event_filter) {
+ if ($event_defaulted and $event_warning == 0) {
+ # only print this warning if necessary:
+ # when we defaulted and there was
+ # multiple event types.
+ print STDERR "Filtering for events of
type: $event\n";
+ $event_warning = 1;
+ }
+ next;
+ }
+ }
+
+ if (not $period) {
+ $period = 1
+ }
+ ($m_pid, $m_tid, $m_period) = ($pid, $tid, $period);
+
+ if ($include_tid) {
+ $pname = "$comm-$m_pid/$m_tid";
+ } elsif ($include_pid) {
+ $pname = "$comm-$m_pid";
+ } else {
+ $pname = "$comm";
+ }
+ $pname =~ tr/ /_/;
+
+ #
+ # stack line
+ #
+ } elsif (/^\s*(\w+)\s*(.+) \((.*)\)/) {
+ # ignore filtered samples
+ next if not $pname;
+
+ my ($pc, $rawfunc, $mod) = ($1, $2, $3);
+
+ if ($show_inline == 1 && $mod !~
m/(perf-\d+.map|kernel\.|\[[^\]]+\])/) {
+ my $inlineRes = inline($pc, $rawfunc, $mod);
+ # - empty result this happens e.g., when $mod does not
exist or is a path to a compressed kernel module
+ # if this happens, the user will see error message
from addr2line written to stderr
+ # - if addr2line results in "??" , then it's much more
sane to fall back than produce a '??' in graph
+ if($inlineRes ne "" and $inlineRes ne "??" and
$inlineRes ne "??:??:0" ) {
+ unshift @stack, $inlineRes;
+ next;
+ }
+ }
+
+ # Linux 4.8 included symbol offsets in perf script output by
default, eg:
+ # 7fffb84c9afc cpu_startup_entry+0x800047c022ec
([kernel.kallsyms])
+ # strip these off:
+ $rawfunc =~ s/\+0x[\da-f]+$//;
+
+ next if $rawfunc =~ /^\(/; # skip process names
+
+ my $is_unknown=0;
+ my @inline;
+ for (split /\->/, $rawfunc) {
+ my $func = $_;
+
+ if ($func eq "[unknown]") {
+ if ($mod ne "[unknown]") { # use module name
instead, if known
+ $func = $mod;
+ $func =~ s/.*\///;
+ } else {
+ $func = "unknown";
+ $is_unknown=1;
+ }
+
+ if ($include_addrs) {
+ $func = "\[$func \<$pc\>\]";
+ } else {
+ $func = "\[$func\]";
+ }
+ }
+
+ if ($tidy_generic) {
+ $func =~ s/;/:/g;
+ if ($func !~ m/\.\(.*\)\./) {
+ # This doesn't look like a Go method
name (such as
+ # "net/http.(*Client).Do"), so
everything after the first open
+ # paren (that is not part of an
"(anonymous namespace)") is
+ # just noise.
+ $func =~ s/\((?!anonymous
namespace\)).*//;
+ }
+ # now tidy this horrible thing:
+ # 13a80b608e0a RegExp:[&<>\"\']
(/tmp/perf-7539.map)
+ $func =~ tr/"\'//d;
+ # fall through to $tidy_java
+ }
+
+ if ($tidy_java and $pname =~ m/^java/) {
+ # along with $tidy_generic, converts the
following:
+ #
Lorg/mozilla/javascript/ContextFactory;.call(Lorg/mozilla/javascript/ContextAction;)Ljava/lang/Object;
+ #
Lorg/mozilla/javascript/ContextFactory;.call(Lorg/mozilla/javascript/C
+ #
Lorg/mozilla/javascript/MemberBox;.<init>(Ljava/lang/reflect/Method;)V
+ # into:
+ #
org/mozilla/javascript/ContextFactory:.call
+ #
org/mozilla/javascript/ContextFactory:.call
+ # org/mozilla/javascript/MemberBox:.init
+ $func =~ s/^L// if $func =~ m:/:;
+ }
+
+ #
+ # Annotations
+ #
+ # detect inlined from the @inline array
+ # detect kernel from the module name; eg, frames to
parse include:
+ # ffffffff8103ce3b native_safe_halt
([kernel.kallsyms])
+ # 8c3453 tcp_sendmsg
(/lib/modules/4.3.0-rc1-virtual/build/vmlinux)
+ # 7d8 ipv4_conntrack_local+0x7f8f80b8
([nf_conntrack_ipv4])
+ # detect jit from the module name; eg:
+ # 7f722d142778 Ljava/io/PrintStream;::print
(/tmp/perf-19982.map)
+ if (scalar(@inline) > 0) {
+ $func .= "_[i]" unless $func =~ m/\_\[i\]/;
# inlined
+ } elsif ($annotate_kernel == 1 && $mod =~
m/(^\[|vmlinux$)/ && $mod !~ /unknown/) {
+ $func .= "_[k]"; # kernel
+ } elsif ($annotate_jit == 1 && $mod =~
m:/tmp/perf-\d+\.map:) {
+ $func .= "_[j]" unless $func =~ m/\_\[j\]/;
# jitted
+ }
+
+ #
+ # Source lines
+ #
+ #
+ # Sample outputs:
+ # | a.out 35081 252436.005167: 667783 cycles:
+ # | 408ebb some_method_name+0x8b
(/full/path/to/a.out)
+ # | uniform_int_dist.h:300
+ # | 4069f5 main+0x935
(/full/path/to/a.out)
+ # | file.cpp:137
+ # | 7f6d2148eb25 __libc_start_main+0xd5
(/lib64/libc-2.33.so)
+ # | libc-2.33.so[27b25]
+ #
+ # | a.out 35081 252435.738165: 306459 cycles:
+ # | 7f6d213c2750 [unknown]
(/usr/lib64/libkmod.so.2.3.6)
+ # | libkmod.so.2.3.6[6750]
+ #
+ # | a.out 35081 252435.738373: 315813 cycles:
+ # | 7f6d215ca51b __strlen_avx2+0x4b
(/lib64/libc-2.33.so)
+ # | libc-2.33.so[16351b]
+ # | 7ffc71ee9580 [unknown] ([unknown])
+ # |
+ #
+ # | a.out 35081 252435.718940: 247984 cycles:
+ # | ffffffff814f9302 up_write+0x32
([kernel.kallsyms])
+ # | [kernel.kallsyms][ffffffff814f9302]
+ if($srcline_in_input and not $is_unknown){
+ $_ = <>;
+ chomp;
+ s/\[.*?\]//g;
+ s/^\s*//g;
+ s/\s*$//g;
+ $func.=':'.$_ unless $_ eq "";
+ }
+
+ push @inline, $func;
+ }
+
+ unshift @stack, @inline;
+ } else {
+ warn "Unrecognized line: $_";
+ }
+}
+
+foreach my $k (sort { $a cmp $b } keys %collapsed) {
+ print "$k $collapsed{$k}\n";
+}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
