#!/usr/bin/env python2.7 from __future__ import print_function desc = '''Generate HTML output to visualize optimization records from the YAML files generated with -fsave-optimization-record and -fdiagnostics-show-hotness. The tools requires PyYAML and Pygments Python packages.''' import yaml import argparse import os.path import subprocess import shutil from pygments import highlight from pygments.lexers.c_cpp import CppLexer from pygments.formatters import HtmlFormatter parser = argparse.ArgumentParser(description=desc) parser.add_argument('yaml_files', nargs='+') parser.add_argument('output_dir') parser.add_argument('-source-dir', '-s', default='', help='set source directory') args = parser.parse_args() p = subprocess.Popen(['c++filt', '-n'], stdin=subprocess.PIPE, stdout=subprocess.PIPE) def demangle(name): p.stdin.write(name + '\n') return p.stdout.readline().rstrip() class Remark(yaml.YAMLObject): max_hotness = 1 # Map function names to their source location for function where inlining happened caller_loc = dict() @property def File(self): return self.DebugLoc['File'] @property def Line(self): return int(self.DebugLoc['Line']) @property def Column(self): return self.DebugLoc['Column'] @property def DebugLocString(self): return "{}:{}:{}".format(self.File, self.Line, self.Column) @property def DemangledFunctionName(self): return demangle(self.Function) @classmethod def make_link(cls, File, Line): return "{}#L{}".format(SourceFileRenderer.html_file_name(File), Line) @property def Link(self): return Remark.make_link(self.File, self.Line) def getArgString(self, mapping): mapping = mapping.copy() dl = mapping.get('DebugLoc') if dl: del mapping['DebugLoc'] assert(len(mapping) == 1) (key, value) = mapping.items()[0] if key == 'Caller' or key == 'Callee': value = demangle(value) if dl and key != 'Caller': return "{}".format( Remark.make_link(dl['File'], dl['Line']), value) else: return value @property def message(self): # Args is a list of mappings (dictionaries) values = [self.getArgString(mapping) for mapping in self.Args] return "".join(values) @property def RelativeHotness(self): return int(round(self.Hotness * 100 / Remark.max_hotness)) @property def key(self): return (self.__class__, self.Pass, self.Name, self.File, self.Line, self.Column, self.message) class Analysis(Remark): yaml_tag = '!Analysis' @property def color(self): return "white" class AnalysisFPCommute(Analysis): yaml_tag = '!AnalysisFPCommute' class AnalysisAliasing(Analysis): yaml_tag = '!AnalysisAliasing' class Passed(Remark): yaml_tag = '!Passed' @property def color(self): return "green" class Missed(Remark): yaml_tag = '!Missed' @property def color(self): return "red" class SourceFileRenderer: def __init__(self, filename): existing_filename = None if os.path.exists(filename): existing_filename = filename else: fn = os.path.join(args.source_dir, filename) if os.path.exists(fn): existing_filename = fn self.stream = open(os.path.join(args.output_dir, SourceFileRenderer.html_file_name(filename)), 'w') if existing_filename: self.source_stream = open(existing_filename) else: self.source_stream = None print('''

Unable to locate file {}

'''.format(filename), file=self.stream) self.html_formatter = HtmlFormatter() self.cpp_lexer = CppLexer() def render_source_line(self, linenum, line): html_line = highlight(line, self.cpp_lexer, self.html_formatter) print(''' {linenum} {html_line} '''.format(**locals()), file=self.stream) def render_inline_remarks(self, r): inlining_context = r.DemangledFunctionName dl = Remark.caller_loc.get(r.Function) if dl: link = Remark.make_link(dl['File'], dl['Line'] - 2) inlining_context = "{r.DemangledFunctionName}".format(**locals()) print(''' {r.RelativeHotness}% {r.Pass} {r.message} {inlining_context} '''.format(**locals()), file=self.stream) def render(self, line_remarks): if not self.source_stream: return print('''

''', file=self.stream) for (linenum, line) in enumerate(self.source_stream.readlines(), start=1): self.render_source_line(linenum, line) for remark in line_remarks.get(linenum, []): self.render_inline_remarks(remark) print('''

Line

Hotness

Optimization

Source

Inline Context

''', file=self.stream) @classmethod def html_file_name(cls, filename): return filename.replace('/', '_') + ".html" class IndexRenderer: def __init__(self): self.stream = open(os.path.join(args.output_dir, 'index.html'), 'w') def render_entry(self, r): print(''' {r.DebugLocString} {r.RelativeHotness}% {r.DemangledFunctionName} {r.Pass} '''.format(**locals()), file=self.stream) def render(self, all_remarks): print('''

''', file=self.stream) for remark in all_remarks: self.render_entry(remark) print('''

Source Location

Hotness

Function

Pass

''', file=self.stream) all_remarks = dict() file_remarks = dict() for input_file in args.yaml_files: f = open(input_file) docs = yaml.load_all(f) for remark in docs: if hasattr(remark, 'Hotness'): # Avoid duplicated remarks if remark.key in all_remarks: continue all_remarks[remark.key] = remark file_remarks.setdefault(remark.File, dict()).setdefault(remark.Line, []).append(remark); Remark.max_hotness = max(Remark.max_hotness, remark.Hotness) # Set up a map between function names and their source location for function where inlining happened for remark in all_remarks.itervalues(): if type(remark) == Passed and remark.Pass == "inline" and remark.Name == "Inlined": for arg in remark.Args: caller = arg.get('Caller') if caller: Remark.caller_loc[caller] = arg['DebugLoc'] sorted_remarks = sorted(all_remarks.itervalues(), key=lambda r: r.Hotness, reverse=True) if not os.path.exists(args.output_dir): os.mkdir(args.output_dir) for (filename, remarks) in file_remarks.iteritems(): SourceFileRenderer(filename).render(remarks) IndexRenderer().render(sorted_remarks) shutil.copy(os.path.join(os.path.dirname(os.path.realpath(__file__)), "style.css"), args.output_dir)