# flamegraph.py - create flame graphs from perf samples # SPDX-License-Identifier: GPL-2.0 # # Usage: # # perf record -a -g -F 99 sleep 60 # perf script report flamegraph # # Combined: # # perf script flamegraph -a -F 99 sleep 60 # # Written by Andreas Gerstmayr # Flame Graphs invented by Brendan Gregg # Works in tandem with d3-flame-graph by Martin Spier # # pylint: disable=missing-module-docstring # pylint: disable=missing-class-docstring # pylint: disable=missing-function-docstring from __future__ import print_function import sys import os import io import argparse import json import subprocess # pylint: disable=too-few-public-methods class Node: def __init__(self, name, libtype): self.name = name # "root" | "kernel" | "" # "" indicates user space self.libtype = libtype self.value = 0 self.children = [] def to_json(self): return { "n": self.name, "l": self.libtype, "v": self.value, "c": self.children } class FlameGraphCLI: def __init__(self, args): self.args = args self.stack = Node("all", "root") if self.args.format == "html" and \ not os.path.isfile(self.args.template): print("Flame Graph template {} does not exist. Please install " "the js-d3-flame-graph (RPM) or libjs-d3-flame-graph (deb) " "package, specify an existing flame graph template " "(--template PATH) or another output format " "(--format FORMAT).".format(self.args.template), file=sys.stderr) sys.exit(1) @staticmethod def get_libtype_from_dso(dso): """ when kernel-debuginfo is installed, dso points to /usr/lib/debug/lib/modules/*/vmlinux """ if dso and (dso == "[kernel.kallsyms]" or dso.endswith("/vmlinux")): return "kernel" return "" @staticmethod def find_or_create_node(node, name, libtype): for child in node.children: if child.name == name: return child child = Node(name, libtype) node.children.append(child) return child def process_event(self, event): pid = event.get("sample", {}).get("pid", 0) # event["dso"] sometimes contains /usr/lib/debug/lib/modules/*/vmlinux # for user-space processes; let's use pid for kernel or user-space distinction if pid == 0: comm = event["comm"] libtype = "kernel" else: comm = "{} ({})".format(event["comm"], pid) libtype = "" node = self.find_or_create_node(self.stack, comm, libtype) if "callchain" in event: for entry in reversed(event["callchain"]): name = entry.get("sym", {}).get("name", "[unknown]") libtype = self.get_libtype_from_dso(entry.get("dso")) node = self.find_or_create_node(node, name, libtype) else: name = event.get("symbol", "[unknown]") libtype = self.get_libtype_from_dso(event.get("dso")) node = self.find_or_create_node(node, name, libtype) node.value += 1 def get_report_header(self): if self.args.input == "-": # when this script is invoked with "perf script flamegraph", # no perf.data is created and we cannot read the header of it return "" try: output = subprocess.check_output(["perf", "report", "--header-only"]) return output.decode("utf-8") except Exception as err: # pylint: disable=broad-except print("Error reading report header: {}".format(err), file=sys.stderr) return "" def trace_end(self): stacks_json = json.dumps(self.stack, default=lambda x: x.to_json()) if self.args.format == "html": report_header = self.get_report_header() options = { "colorscheme": self.args.colorscheme, "context": report_header } options_json = json.dumps(options) try: with io.open(self.args.template, encoding="utf-8") as template: output_str = ( template.read() .replace("/** @options_json **/", options_json) .replace("/** @flamegraph_json **/", stacks_json) ) except IOError as err: print("Error reading template file: {}".format(err), file=sys.stderr) sys.exit(1) output_fn = self.args.output or "flamegraph.html" else: output_str = stacks_json output_fn = self.args.output or "stacks.json" if output_fn == "-": with io.open(sys.stdout.fileno(), "w", encoding="utf-8", closefd=False) as out: out.write(output_str) else: print("dumping data to {}".format(output_fn)) try: with io.open(output_fn, "w", encoding="utf-8") as out: out.write(output_str) except IOError as err: print("Error writing output file: {}".format(err), file=sys.stderr) sys.exit(1) if __name__ == "__main__": parser = argparse.ArgumentParser(description="Create flame graphs.") parser.add_argument("-f", "--format", default="html", choices=["json", "html"], help="output file format") parser.add_argument("-o", "--output", help="output file name") parser.add_argument("--template", default="/usr/share/d3-flame-graph/d3-flamegraph-base.html", help="path to flame graph HTML template") parser.add_argument("--colorscheme", default="blue-green", help="flame graph color scheme", choices=["blue-green", "orange"]) parser.add_argument("-i", "--input", help=argparse.SUPPRESS) cli_args = parser.parse_args() cli = FlameGraphCLI(cli_args) process_event = cli.process_event trace_end = cli.trace_end 8d66defa1ce59a34a41a96f49771&showmsg=1'>Expand)Author 2017-11-02License cleanup: add SPDX GPL-2.0 license identifier to files with no licenseGreg Kroah-Hartman 2016-04-22x86, drivers/pnpbios: Replace paravirt_enabled() check with legacy device checkLuis R. Rodriguez 2015-03-18PNP: Add helper macro for pnp_register_driver boilerplatePeter Huewe 2015-02-02PNP: Allow console to override ACPI device sleepPeter Hurley 2011-06-10treewide: Convert uses of struct resource to resource_size(ptr)Joe Perches 2010-07-19PNPACPI: Add support for remote wakeupAlan Stern 2009-12-15PNP: add interface to retrieve ACPI device from a PNPACPI deviceBjorn Helgaas 2009-09-22pnp: add a shutdown method to pnp driversDavid Härdeman 2009-06-05pnp: add PNP resource range checking functionBjorn Helgaas 2008-10-23Merge branch 'linus' into testLen Brown 2008-10-16pnp: make the resource type an unsigned longRene Herman 2008-10-10PNP: convert the last few pnp_info() uses to printk()Bjorn Helgaas 2008-09-16Fix PNP build failure, bugzilla #11276David Miller 2008-07-16PNP: convert resource options to single linked listBjorn Helgaas 2008-07-16PNP: make resource option structures private to PNP subsystemBjorn Helgaas 2008-07-16PNP: define PNP-specific IORESOURCE_IO_* flags alongside IRQ, DMA, MEMBjorn Helgaas 2008-07-16PNP: add pnp_possible_config() -- can a device could be configured this way?Bjorn Helgaas 2008-07-16PNP: replace pnp_resource_table with dynamically allocated resourcesBjorn Helgaas 2008-07-16PNP: make pnp_{port,mem,etc}_start(), et al work for invalid resourcesBjorn Helgaas 2008-04-30Merge branch 'release' of git://git.kernel.org/pub/scm/linux/kernel/git/lenb/...Linus Torvalds 2008-04-30Remove "#ifdef __KERNEL__" checks from unexported headersRobert P. J. Day 2008-04-29ISAPNP: remove unused pnp_dev->regs fieldBjorn Helgaas 2008-04-29PNP: make interfaces private to the PNP coreBjorn Helgaas 2008-04-29PNP: make pnp_resource_table private to PNP coreBjorn Helgaas 2008-04-29PNP: convert resource accessors to use pnp_get_resource(), not pnp_resource_t...Bjorn Helgaas 2008-04-29PNP: add pnp_get_resource() interfaceBjorn Helgaas 2008-04-29PNP: remove unused interfaces using pnp_resource_tableBjorn Helgaas 2008-04-29PNP: add pnp_init_resources(struct pnp_dev *) interfaceBjorn Helgaas 2008-04-29PNP: remove pnp_resource_table from internal get/set interfacesBjorn Helgaas 2008-04-29PNP: add debug output to option registrationBjorn Helgaas 2008-04-29PNP: make pnp_add_card_id() internal to PNP coreBjorn Helgaas 2008-04-29PNP: make pnp_add_id() internal to PNP coreBjorn Helgaas 2008-04-11pnp: increase number of devices supported per protocolBjorn Helgaas 2008-03-22PNP: increase the number of PnP memory resources from 12 to 24Darren Salt 2008-02-06isapnp driver semaphore to mutexDaniel Walker 2008-02-03include/linux/: Spelling fixesJoe Perches 2007-12-27increase PNP_MAX_PORT to 40 from 24Len Brown 2007-11-29PNP: increase the maximum number of resourcesZhao Yakui 2007-10-17PNP: remove null pointer checksBjorn Helgaas 2007-07-26PNP: fix up after LindentBjorn Helgaas 2007-07-26PNP: Lindent all source filesBjorn Helgaas 2007-07-22ACPI, PNP: hook ACPI D-state to PNP suspend/resumeShaohua Li 2007-05-08PNP: notice whether we have PNP devices (PNPBIOS or PNPACPI)Bjorn Helgaas 2007-05-08init dma masks in pnp_devDavid Brownell 2007-02-11[PATCH] PNP: export pnp_bus_typeDavid Brownell 2006-06-27[PATCH] 64bit resource: change pnp core to use resource_size_tGreg Kroah-Hartman