Serge Guelton | 6da47be | 2019-01-03 15:44:24 +0000 | [diff] [blame] | 1 | #!/usr/bin/env python |
Adam Nemet | db695f4 | 2016-10-07 17:06:34 +0000 | [diff] [blame] | 2 | |
| 3 | from __future__ import print_function |
| 4 | |
Brian Gesiak | fb66991 | 2017-06-29 18:56:25 +0000 | [diff] [blame] | 5 | import argparse |
| 6 | import cgi |
Adam Nemet | 747f7a4 | 2017-12-14 18:42:42 +0000 | [diff] [blame] | 7 | import codecs |
Brian Gesiak | fb66991 | 2017-06-29 18:56:25 +0000 | [diff] [blame] | 8 | import errno |
| 9 | import functools |
| 10 | from multiprocessing import cpu_count |
| 11 | import os.path |
| 12 | import re |
| 13 | import shutil |
Roman Lebedev | cbdd389 | 2017-10-10 19:34:15 +0000 | [diff] [blame] | 14 | import sys |
Brian Gesiak | fb66991 | 2017-06-29 18:56:25 +0000 | [diff] [blame] | 15 | |
| 16 | from pygments import highlight |
| 17 | from pygments.lexers.c_cpp import CppLexer |
| 18 | from pygments.formatters import HtmlFormatter |
| 19 | |
| 20 | import optpmap |
| 21 | import optrecord |
| 22 | |
| 23 | |
Adam Nemet | db695f4 | 2016-10-07 17:06:34 +0000 | [diff] [blame] | 24 | desc = '''Generate HTML output to visualize optimization records from the YAML files |
| 25 | generated with -fsave-optimization-record and -fdiagnostics-show-hotness. |
| 26 | |
Adam Nemet | a3f7c6a | 2017-03-01 00:54:40 +0000 | [diff] [blame] | 27 | The tools requires PyYAML and Pygments Python packages.''' |
Adam Nemet | db695f4 | 2016-10-07 17:06:34 +0000 | [diff] [blame] | 28 | |
Adam Nemet | db695f4 | 2016-10-07 17:06:34 +0000 | [diff] [blame] | 29 | |
Adam Nemet | 2276fd3 | 2017-01-27 06:39:09 +0000 | [diff] [blame] | 30 | # This allows passing the global context to the child processes. |
| 31 | class Context: |
Adam Nemet | aa64e90 | 2017-03-01 21:35:00 +0000 | [diff] [blame] | 32 | def __init__(self, caller_loc = dict()): |
Adam Nemet | 2276fd3 | 2017-01-27 06:39:09 +0000 | [diff] [blame] | 33 | # Map function names to their source location for function where inlining happened |
| 34 | self.caller_loc = caller_loc |
Adam Nemet | 29e1623 | 2016-11-11 06:11:56 +0000 | [diff] [blame] | 35 | |
Adam Nemet | 2276fd3 | 2017-01-27 06:39:09 +0000 | [diff] [blame] | 36 | context = Context() |
| 37 | |
Adam Nemet | af12c3e | 2017-12-06 16:50:50 +0000 | [diff] [blame] | 38 | def suppress(remark): |
| 39 | if remark.Name == 'sil.Specialized': |
| 40 | return remark.getArgDict()['Function'][0].startswith('\"Swift.') |
| 41 | elif remark.Name == 'sil.Inlined': |
| 42 | return remark.getArgDict()['Callee'][0].startswith(('\"Swift.', '\"specialized Swift.')) |
| 43 | return False |
| 44 | |
Adam Nemet | db695f4 | 2016-10-07 17:06:34 +0000 | [diff] [blame] | 45 | class SourceFileRenderer: |
Zachary Turner | 135e942 | 2018-01-05 22:05:13 +0000 | [diff] [blame] | 46 | def __init__(self, source_dir, output_dir, filename, no_highlight): |
Adam Nemet | 2ee19a3 | 2018-02-26 21:15:50 +0000 | [diff] [blame] | 47 | self.filename = filename |
Adam Nemet | 9781343 | 2016-11-11 01:08:02 +0000 | [diff] [blame] | 48 | existing_filename = None |
| 49 | if os.path.exists(filename): |
| 50 | existing_filename = filename |
| 51 | else: |
Adam Nemet | 9d0307b | 2017-01-27 06:38:31 +0000 | [diff] [blame] | 52 | fn = os.path.join(source_dir, filename) |
Adam Nemet | 9781343 | 2016-11-11 01:08:02 +0000 | [diff] [blame] | 53 | if os.path.exists(fn): |
| 54 | existing_filename = fn |
| 55 | |
Zachary Turner | 135e942 | 2018-01-05 22:05:13 +0000 | [diff] [blame] | 56 | self.no_highlight = no_highlight |
Adam Nemet | 747f7a4 | 2017-12-14 18:42:42 +0000 | [diff] [blame] | 57 | self.stream = codecs.open(os.path.join(output_dir, optrecord.html_file_name(filename)), 'w', encoding='utf-8') |
Adam Nemet | 9781343 | 2016-11-11 01:08:02 +0000 | [diff] [blame] | 58 | if existing_filename: |
| 59 | self.source_stream = open(existing_filename) |
| 60 | else: |
| 61 | self.source_stream = None |
| 62 | print(''' |
| 63 | <html> |
| 64 | <h1>Unable to locate file {}</h1> |
| 65 | </html> |
| 66 | '''.format(filename), file=self.stream) |
| 67 | |
Adam Nemet | 20a63f1 | 2017-02-10 04:50:18 +0000 | [diff] [blame] | 68 | self.html_formatter = HtmlFormatter(encoding='utf-8') |
Brian Cain | 34b4908 | 2017-02-18 15:13:58 +0000 | [diff] [blame] | 69 | self.cpp_lexer = CppLexer(stripnl=False) |
Adam Nemet | db695f4 | 2016-10-07 17:06:34 +0000 | [diff] [blame] | 70 | |
Brian Cain | 34b4908 | 2017-02-18 15:13:58 +0000 | [diff] [blame] | 71 | def render_source_lines(self, stream, line_remarks): |
| 72 | file_text = stream.read() |
Adam Nemet | d3ee065 | 2017-11-29 17:07:41 +0000 | [diff] [blame] | 73 | |
Zachary Turner | 135e942 | 2018-01-05 22:05:13 +0000 | [diff] [blame] | 74 | if self.no_highlight: |
Serge Guelton | 7633906 | 2019-01-03 14:40:34 +0000 | [diff] [blame] | 75 | if sys.version_info.major >= 3: |
| 76 | html_highlighted = file_text |
| 77 | else: |
| 78 | html_highlighted = file_text.decode('utf-8') |
Adam Nemet | d3ee065 | 2017-11-29 17:07:41 +0000 | [diff] [blame] | 79 | else: |
| 80 | html_highlighted = highlight( |
Brian Gesiak | 6ab3297 | 2017-08-11 18:05:26 +0000 | [diff] [blame] | 81 | file_text, |
Adam Nemet | d3ee065 | 2017-11-29 17:07:41 +0000 | [diff] [blame] | 82 | self.cpp_lexer, |
| 83 | self.html_formatter) |
Roman Lebedev | cbdd389 | 2017-10-10 19:34:15 +0000 | [diff] [blame] | 84 | |
Adam Nemet | 747f7a4 | 2017-12-14 18:42:42 +0000 | [diff] [blame] | 85 | # Note that the API is different between Python 2 and 3. On |
| 86 | # Python 3, pygments.highlight() returns a bytes object, so we |
| 87 | # have to decode. On Python 2, the output is str but since we |
| 88 | # support unicode characters and the output streams is unicode we |
| 89 | # decode too. |
| 90 | html_highlighted = html_highlighted.decode('utf-8') |
Brian Cain | 34b4908 | 2017-02-18 15:13:58 +0000 | [diff] [blame] | 91 | |
Adam Nemet | d3ee065 | 2017-11-29 17:07:41 +0000 | [diff] [blame] | 92 | # Take off the header and footer, these must be |
| 93 | # reapplied line-wise, within the page structure |
| 94 | html_highlighted = html_highlighted.replace('<div class="highlight"><pre>', '') |
| 95 | html_highlighted = html_highlighted.replace('</pre></div>', '') |
Brian Cain | 34b4908 | 2017-02-18 15:13:58 +0000 | [diff] [blame] | 96 | |
| 97 | for (linenum, html_line) in enumerate(html_highlighted.split('\n'), start=1): |
Adam Nemet | 747f7a4 | 2017-12-14 18:42:42 +0000 | [diff] [blame] | 98 | print(u''' |
Adam Nemet | db695f4 | 2016-10-07 17:06:34 +0000 | [diff] [blame] | 99 | <tr> |
| 100 | <td><a name=\"L{linenum}\">{linenum}</a></td> |
| 101 | <td></td> |
| 102 | <td></td> |
Brian Cain | 34b4908 | 2017-02-18 15:13:58 +0000 | [diff] [blame] | 103 | <td><div class="highlight"><pre>{html_line}</pre></div></td> |
Adam Nemet | db695f4 | 2016-10-07 17:06:34 +0000 | [diff] [blame] | 104 | </tr>'''.format(**locals()), file=self.stream) |
| 105 | |
Brian Cain | 34b4908 | 2017-02-18 15:13:58 +0000 | [diff] [blame] | 106 | for remark in line_remarks.get(linenum, []): |
Adam Nemet | af12c3e | 2017-12-06 16:50:50 +0000 | [diff] [blame] | 107 | if not suppress(remark): |
| 108 | self.render_inline_remarks(remark, html_line) |
Brian Cain | 34b4908 | 2017-02-18 15:13:58 +0000 | [diff] [blame] | 109 | |
Adam Nemet | 58da394 | 2016-11-11 01:51:34 +0000 | [diff] [blame] | 110 | def render_inline_remarks(self, r, line): |
Adam Nemet | 9295796 | 2016-11-11 01:25:04 +0000 | [diff] [blame] | 111 | inlining_context = r.DemangledFunctionName |
Adam Nemet | 2276fd3 | 2017-01-27 06:39:09 +0000 | [diff] [blame] | 112 | dl = context.caller_loc.get(r.Function) |
Adam Nemet | 9295796 | 2016-11-11 01:25:04 +0000 | [diff] [blame] | 113 | if dl: |
Adam Nemet | b261373 | 2017-07-19 22:04:59 +0000 | [diff] [blame] | 114 | dl_dict = dict(list(dl)) |
| 115 | link = optrecord.make_link(dl_dict['File'], dl_dict['Line'] - 2) |
Adam Nemet | 9295796 | 2016-11-11 01:25:04 +0000 | [diff] [blame] | 116 | inlining_context = "<a href={link}>{r.DemangledFunctionName}</a>".format(**locals()) |
| 117 | |
Adam Nemet | 58da394 | 2016-11-11 01:51:34 +0000 | [diff] [blame] | 118 | # Column is the number of characters *including* tabs, keep those and |
| 119 | # replace everything else with spaces. |
Adam Nemet | 2f28d0c | 2017-02-28 23:59:46 +0000 | [diff] [blame] | 120 | indent = line[:max(r.Column, 1) - 1] |
Adam Nemet | 58da394 | 2016-11-11 01:51:34 +0000 | [diff] [blame] | 121 | indent = re.sub('\S', ' ', indent) |
Adam Nemet | 77d2e86 | 2017-02-02 05:49:02 +0000 | [diff] [blame] | 122 | |
Adam Nemet | 747f7a4 | 2017-12-14 18:42:42 +0000 | [diff] [blame] | 123 | print(u''' |
Adam Nemet | db695f4 | 2016-10-07 17:06:34 +0000 | [diff] [blame] | 124 | <tr> |
| 125 | <td></td> |
Adam Nemet | 29e1623 | 2016-11-11 06:11:56 +0000 | [diff] [blame] | 126 | <td>{r.RelativeHotness}</td> |
Adam Nemet | 6a466e7 | 2017-03-02 17:00:59 +0000 | [diff] [blame] | 127 | <td class=\"column-entry-{r.color}\">{r.PassWithDiffPrefix}</td> |
Adam Nemet | 58da394 | 2016-11-11 01:51:34 +0000 | [diff] [blame] | 128 | <td><pre style="display:inline">{indent}</pre><span class=\"column-entry-yellow\"> {r.message} </span></td> |
Adam Nemet | 9295796 | 2016-11-11 01:25:04 +0000 | [diff] [blame] | 129 | <td class=\"column-entry-yellow\">{inlining_context}</td> |
Adam Nemet | db695f4 | 2016-10-07 17:06:34 +0000 | [diff] [blame] | 130 | </tr>'''.format(**locals()), file=self.stream) |
| 131 | |
| 132 | def render(self, line_remarks): |
Adam Nemet | 9781343 | 2016-11-11 01:08:02 +0000 | [diff] [blame] | 133 | if not self.source_stream: |
| 134 | return |
| 135 | |
Adam Nemet | db695f4 | 2016-10-07 17:06:34 +0000 | [diff] [blame] | 136 | print(''' |
| 137 | <html> |
Adam Nemet | 2ee19a3 | 2018-02-26 21:15:50 +0000 | [diff] [blame] | 138 | <title>{}</title> |
Adam Nemet | 71f21a2 | 2017-12-14 18:55:33 +0000 | [diff] [blame] | 139 | <meta charset="utf-8" /> |
Adam Nemet | db695f4 | 2016-10-07 17:06:34 +0000 | [diff] [blame] | 140 | <head> |
| 141 | <link rel='stylesheet' type='text/css' href='style.css'> |
| 142 | </head> |
| 143 | <body> |
| 144 | <div class="centered"> |
Adam Nemet | 47a3615 | 2017-11-14 04:48:18 +0000 | [diff] [blame] | 145 | <table class="source"> |
| 146 | <thead> |
Adam Nemet | db695f4 | 2016-10-07 17:06:34 +0000 | [diff] [blame] | 147 | <tr> |
Adam Nemet | 47a3615 | 2017-11-14 04:48:18 +0000 | [diff] [blame] | 148 | <th style="width: 2%">Line</td> |
| 149 | <th style="width: 3%">Hotness</td> |
| 150 | <th style="width: 10%">Optimization</td> |
| 151 | <th style="width: 70%">Source</td> |
| 152 | <th style="width: 15%">Inline Context</td> |
| 153 | </tr> |
| 154 | </thead> |
Adam Nemet | 2ee19a3 | 2018-02-26 21:15:50 +0000 | [diff] [blame] | 155 | <tbody>'''.format(os.path.basename(self.filename)), file=self.stream) |
Brian Cain | 34b4908 | 2017-02-18 15:13:58 +0000 | [diff] [blame] | 156 | self.render_source_lines(self.source_stream, line_remarks) |
| 157 | |
Adam Nemet | db695f4 | 2016-10-07 17:06:34 +0000 | [diff] [blame] | 158 | print(''' |
Adam Nemet | 47a3615 | 2017-11-14 04:48:18 +0000 | [diff] [blame] | 159 | </tbody> |
Adam Nemet | db695f4 | 2016-10-07 17:06:34 +0000 | [diff] [blame] | 160 | </table> |
| 161 | </body> |
| 162 | </html>''', file=self.stream) |
| 163 | |
Mandeep Singh Grang | c75e3c2 | 2016-11-11 04:51:27 +0000 | [diff] [blame] | 164 | |
Adam Nemet | db695f4 | 2016-10-07 17:06:34 +0000 | [diff] [blame] | 165 | class IndexRenderer: |
Zachary Turner | 135e942 | 2018-01-05 22:05:13 +0000 | [diff] [blame] | 166 | def __init__(self, output_dir, should_display_hotness, max_hottest_remarks_on_index): |
Adam Nemet | 747f7a4 | 2017-12-14 18:42:42 +0000 | [diff] [blame] | 167 | self.stream = codecs.open(os.path.join(output_dir, 'index.html'), 'w', encoding='utf-8') |
Adam Nemet | 0c383f6 | 2017-11-14 04:37:32 +0000 | [diff] [blame] | 168 | self.should_display_hotness = should_display_hotness |
Zachary Turner | 135e942 | 2018-01-05 22:05:13 +0000 | [diff] [blame] | 169 | self.max_hottest_remarks_on_index = max_hottest_remarks_on_index |
Adam Nemet | db695f4 | 2016-10-07 17:06:34 +0000 | [diff] [blame] | 170 | |
Adam Nemet | 73efe1f | 2017-02-02 05:49:00 +0000 | [diff] [blame] | 171 | def render_entry(self, r, odd): |
Adam Nemet | 77d2e86 | 2017-02-02 05:49:02 +0000 | [diff] [blame] | 172 | escaped_name = cgi.escape(r.DemangledFunctionName) |
Adam Nemet | 747f7a4 | 2017-12-14 18:42:42 +0000 | [diff] [blame] | 173 | print(u''' |
Adam Nemet | 43573fb | 2016-10-11 16:19:06 +0000 | [diff] [blame] | 174 | <tr> |
Adam Nemet | 73efe1f | 2017-02-02 05:49:00 +0000 | [diff] [blame] | 175 | <td class=\"column-entry-{odd}\"><a href={r.Link}>{r.DebugLocString}</a></td> |
| 176 | <td class=\"column-entry-{odd}\">{r.RelativeHotness}</td> |
Adam Nemet | 77d2e86 | 2017-02-02 05:49:02 +0000 | [diff] [blame] | 177 | <td class=\"column-entry-{odd}\">{escaped_name}</td> |
Adam Nemet | 6a466e7 | 2017-03-02 17:00:59 +0000 | [diff] [blame] | 178 | <td class=\"column-entry-{r.color}\">{r.PassWithDiffPrefix}</td> |
Adam Nemet | 43573fb | 2016-10-11 16:19:06 +0000 | [diff] [blame] | 179 | </tr>'''.format(**locals()), file=self.stream) |
Adam Nemet | db695f4 | 2016-10-07 17:06:34 +0000 | [diff] [blame] | 180 | |
| 181 | def render(self, all_remarks): |
| 182 | print(''' |
| 183 | <html> |
Adam Nemet | 71f21a2 | 2017-12-14 18:55:33 +0000 | [diff] [blame] | 184 | <meta charset="utf-8" /> |
Adam Nemet | db695f4 | 2016-10-07 17:06:34 +0000 | [diff] [blame] | 185 | <head> |
| 186 | <link rel='stylesheet' type='text/css' href='style.css'> |
| 187 | </head> |
| 188 | <body> |
| 189 | <div class="centered"> |
| 190 | <table> |
| 191 | <tr> |
| 192 | <td>Source Location</td> |
| 193 | <td>Hotness</td> |
| 194 | <td>Function</td> |
| 195 | <td>Pass</td> |
| 196 | </tr>''', file=self.stream) |
Adam Nemet | 0c383f6 | 2017-11-14 04:37:32 +0000 | [diff] [blame] | 197 | |
| 198 | max_entries = None |
Zachary Turner | 135e942 | 2018-01-05 22:05:13 +0000 | [diff] [blame] | 199 | if self.should_display_hotness: |
| 200 | max_entries = self.max_hottest_remarks_on_index |
Adam Nemet | 0c383f6 | 2017-11-14 04:37:32 +0000 | [diff] [blame] | 201 | |
| 202 | for i, remark in enumerate(all_remarks[:max_entries]): |
Adam Nemet | af12c3e | 2017-12-06 16:50:50 +0000 | [diff] [blame] | 203 | if not suppress(remark): |
| 204 | self.render_entry(remark, i % 2) |
Adam Nemet | db695f4 | 2016-10-07 17:06:34 +0000 | [diff] [blame] | 205 | print(''' |
| 206 | </table> |
| 207 | </body> |
| 208 | </html>''', file=self.stream) |
| 209 | |
| 210 | |
Zachary Turner | 135e942 | 2018-01-05 22:05:13 +0000 | [diff] [blame] | 211 | def _render_file(source_dir, output_dir, ctx, no_highlight, entry): |
Adam Nemet | 2276fd3 | 2017-01-27 06:39:09 +0000 | [diff] [blame] | 212 | global context |
| 213 | context = ctx |
Adam Nemet | 9d0307b | 2017-01-27 06:38:31 +0000 | [diff] [blame] | 214 | filename, remarks = entry |
Zachary Turner | 135e942 | 2018-01-05 22:05:13 +0000 | [diff] [blame] | 215 | SourceFileRenderer(source_dir, output_dir, filename, no_highlight).render(remarks) |
Adam Nemet | 9d0307b | 2017-01-27 06:38:31 +0000 | [diff] [blame] | 216 | |
| 217 | |
Adam Nemet | 9d0307b | 2017-01-27 06:38:31 +0000 | [diff] [blame] | 218 | def map_remarks(all_remarks): |
| 219 | # Set up a map between function names and their source location for |
| 220 | # function where inlining happened |
Brian Gesiak | 11d48a5 | 2017-06-29 18:47:31 +0000 | [diff] [blame] | 221 | for remark in optrecord.itervalues(all_remarks): |
Adam Nemet | aa64e90 | 2017-03-01 21:35:00 +0000 | [diff] [blame] | 222 | if isinstance(remark, optrecord.Passed) and remark.Pass == "inline" and remark.Name == "Inlined": |
Adam Nemet | 9d0307b | 2017-01-27 06:38:31 +0000 | [diff] [blame] | 223 | for arg in remark.Args: |
Adam Nemet | b261373 | 2017-07-19 22:04:59 +0000 | [diff] [blame] | 224 | arg_dict = dict(list(arg)) |
| 225 | caller = arg_dict.get('Caller') |
Adam Nemet | 9d0307b | 2017-01-27 06:38:31 +0000 | [diff] [blame] | 226 | if caller: |
Davide Italiano | 54df34c | 2017-07-13 04:19:13 +0000 | [diff] [blame] | 227 | try: |
Adam Nemet | b261373 | 2017-07-19 22:04:59 +0000 | [diff] [blame] | 228 | context.caller_loc[caller] = arg_dict['DebugLoc'] |
Davide Italiano | 54df34c | 2017-07-13 04:19:13 +0000 | [diff] [blame] | 229 | except KeyError: |
| 230 | pass |
Adam Nemet | 9295796 | 2016-11-11 01:25:04 +0000 | [diff] [blame] | 231 | |
Adam Nemet | db695f4 | 2016-10-07 17:06:34 +0000 | [diff] [blame] | 232 | |
Brian Gesiak | fb66991 | 2017-06-29 18:56:25 +0000 | [diff] [blame] | 233 | def generate_report(all_remarks, |
| 234 | file_remarks, |
| 235 | source_dir, |
| 236 | output_dir, |
Zachary Turner | 135e942 | 2018-01-05 22:05:13 +0000 | [diff] [blame] | 237 | no_highlight, |
Brian Gesiak | fb66991 | 2017-06-29 18:56:25 +0000 | [diff] [blame] | 238 | should_display_hotness, |
Zachary Turner | 135e942 | 2018-01-05 22:05:13 +0000 | [diff] [blame] | 239 | max_hottest_remarks_on_index, |
Brian Gesiak | fb66991 | 2017-06-29 18:56:25 +0000 | [diff] [blame] | 240 | num_jobs, |
| 241 | should_print_progress): |
Adam Nemet | 9d0307b | 2017-01-27 06:38:31 +0000 | [diff] [blame] | 242 | try: |
| 243 | os.makedirs(output_dir) |
| 244 | except OSError as e: |
| 245 | if e.errno == errno.EEXIST and os.path.isdir(output_dir): |
| 246 | pass |
| 247 | else: |
| 248 | raise |
Adam Nemet | db695f4 | 2016-10-07 17:06:34 +0000 | [diff] [blame] | 249 | |
Brian Gesiak | fb66991 | 2017-06-29 18:56:25 +0000 | [diff] [blame] | 250 | if should_print_progress: |
Adam Nemet | 2625631 | 2018-02-26 21:15:47 +0000 | [diff] [blame] | 251 | print('Rendering index page...') |
Adam Nemet | aa64e90 | 2017-03-01 21:35:00 +0000 | [diff] [blame] | 252 | if should_display_hotness: |
Brian Gesiak | 11d48a5 | 2017-06-29 18:47:31 +0000 | [diff] [blame] | 253 | sorted_remarks = sorted(optrecord.itervalues(all_remarks), key=lambda r: (r.Hotness, r.File, r.Line, r.Column, r.PassWithDiffPrefix, r.yaml_tag, r.Function), reverse=True) |
Adam Nemet | 9d0307b | 2017-01-27 06:38:31 +0000 | [diff] [blame] | 254 | else: |
Brian Gesiak | 11d48a5 | 2017-06-29 18:47:31 +0000 | [diff] [blame] | 255 | sorted_remarks = sorted(optrecord.itervalues(all_remarks), key=lambda r: (r.File, r.Line, r.Column, r.PassWithDiffPrefix, r.yaml_tag, r.Function)) |
Zachary Turner | 135e942 | 2018-01-05 22:05:13 +0000 | [diff] [blame] | 256 | IndexRenderer(output_dir, should_display_hotness, max_hottest_remarks_on_index).render(sorted_remarks) |
Adam Nemet | db695f4 | 2016-10-07 17:06:34 +0000 | [diff] [blame] | 257 | |
Adam Nemet | 9d0307b | 2017-01-27 06:38:31 +0000 | [diff] [blame] | 258 | shutil.copy(os.path.join(os.path.dirname(os.path.realpath(__file__)), |
| 259 | "style.css"), output_dir) |
| 260 | |
Adam Nemet | 2625631 | 2018-02-26 21:15:47 +0000 | [diff] [blame] | 261 | _render_file_bound = functools.partial(_render_file, source_dir, output_dir, context, no_highlight) |
| 262 | if should_print_progress: |
| 263 | print('Rendering HTML files...') |
| 264 | optpmap.pmap(_render_file_bound, |
| 265 | file_remarks.items(), |
| 266 | num_jobs, |
| 267 | should_print_progress) |
| 268 | |
Adam Nemet | 9d0307b | 2017-01-27 06:38:31 +0000 | [diff] [blame] | 269 | |
Zachary Turner | 135e942 | 2018-01-05 22:05:13 +0000 | [diff] [blame] | 270 | def main(): |
Adam Nemet | 9d0307b | 2017-01-27 06:38:31 +0000 | [diff] [blame] | 271 | parser = argparse.ArgumentParser(description=desc) |
Adam Nemet | ef31468 | 2017-07-17 18:00:41 +0000 | [diff] [blame] | 272 | parser.add_argument( |
| 273 | 'yaml_dirs_or_files', |
| 274 | nargs='+', |
| 275 | help='List of optimization record files or directories searched ' |
| 276 | 'for optimization record files.') |
Brian Gesiak | 11eef88 | 2017-06-29 16:20:31 +0000 | [diff] [blame] | 277 | parser.add_argument( |
| 278 | '--output-dir', |
| 279 | '-o', |
| 280 | default='html', |
| 281 | help='Path to a directory where generated HTML files will be output. ' |
| 282 | 'If the directory does not already exist, it will be created. ' |
| 283 | '"%(default)s" by default.') |
Adam Nemet | 9d0307b | 2017-01-27 06:38:31 +0000 | [diff] [blame] | 284 | parser.add_argument( |
| 285 | '--jobs', |
| 286 | '-j', |
Zachary Turner | 135e942 | 2018-01-05 22:05:13 +0000 | [diff] [blame] | 287 | default=None, |
Adam Nemet | 9d0307b | 2017-01-27 06:38:31 +0000 | [diff] [blame] | 288 | type=int, |
Brian Gesiak | 23ff095 | 2017-06-10 21:33:27 +0000 | [diff] [blame] | 289 | help='Max job count (defaults to %(default)s, the current CPU count)') |
Adam Nemet | 9d0307b | 2017-01-27 06:38:31 +0000 | [diff] [blame] | 290 | parser.add_argument( |
Adam Nemet | aa1bb20 | 2017-11-27 19:00:22 +0000 | [diff] [blame] | 291 | '--source-dir', |
Adam Nemet | 9d0307b | 2017-01-27 06:38:31 +0000 | [diff] [blame] | 292 | '-s', |
| 293 | default='', |
| 294 | help='set source directory') |
Brian Gesiak | fb66991 | 2017-06-29 18:56:25 +0000 | [diff] [blame] | 295 | parser.add_argument( |
| 296 | '--no-progress-indicator', |
| 297 | '-n', |
| 298 | action='store_true', |
| 299 | default=False, |
| 300 | help='Do not display any indicator of how many YAML files were read ' |
| 301 | 'or rendered into HTML.') |
Adam Nemet | 0c383f6 | 2017-11-14 04:37:32 +0000 | [diff] [blame] | 302 | parser.add_argument( |
| 303 | '--max-hottest-remarks-on-index', |
| 304 | default=1000, |
| 305 | type=int, |
| 306 | help='Maximum number of the hottest remarks to appear on the index page') |
Adam Nemet | d3ee065 | 2017-11-29 17:07:41 +0000 | [diff] [blame] | 307 | parser.add_argument( |
| 308 | '--no-highlight', |
| 309 | action='store_true', |
| 310 | default=False, |
| 311 | help='Do not use a syntax highlighter when rendering the source code') |
| 312 | parser.add_argument( |
| 313 | '--demangler', |
| 314 | help='Set the demangler to be used (defaults to %s)' % optrecord.Remark.default_demangler) |
Zachary Turner | 135e942 | 2018-01-05 22:05:13 +0000 | [diff] [blame] | 315 | |
| 316 | # Do not make this a global variable. Values needed to be propagated through |
| 317 | # to individual classes and functions to be portable with multiprocessing across |
| 318 | # Windows and non-Windows. |
Adam Nemet | 9d0307b | 2017-01-27 06:38:31 +0000 | [diff] [blame] | 319 | args = parser.parse_args() |
| 320 | |
Brian Gesiak | fb66991 | 2017-06-29 18:56:25 +0000 | [diff] [blame] | 321 | print_progress = not args.no_progress_indicator |
Adam Nemet | d3ee065 | 2017-11-29 17:07:41 +0000 | [diff] [blame] | 322 | if args.demangler: |
| 323 | optrecord.Remark.set_demangler(args.demangler) |
Adam Nemet | ef31468 | 2017-07-17 18:00:41 +0000 | [diff] [blame] | 324 | |
Adam Nemet | 41247e1 | 2017-09-29 05:20:53 +0000 | [diff] [blame] | 325 | files = optrecord.find_opt_files(*args.yaml_dirs_or_files) |
Adam Nemet | ef31468 | 2017-07-17 18:00:41 +0000 | [diff] [blame] | 326 | if not files: |
| 327 | parser.error("No *.opt.yaml files found") |
| 328 | sys.exit(1) |
| 329 | |
Brian Gesiak | fb66991 | 2017-06-29 18:56:25 +0000 | [diff] [blame] | 330 | all_remarks, file_remarks, should_display_hotness = \ |
Adam Nemet | ef31468 | 2017-07-17 18:00:41 +0000 | [diff] [blame] | 331 | optrecord.gather_results(files, args.jobs, print_progress) |
Adam Nemet | 9d0307b | 2017-01-27 06:38:31 +0000 | [diff] [blame] | 332 | |
| 333 | map_remarks(all_remarks) |
| 334 | |
Brian Gesiak | fb66991 | 2017-06-29 18:56:25 +0000 | [diff] [blame] | 335 | generate_report(all_remarks, |
| 336 | file_remarks, |
| 337 | args.source_dir, |
| 338 | args.output_dir, |
Zachary Turner | 135e942 | 2018-01-05 22:05:13 +0000 | [diff] [blame] | 339 | args.no_highlight, |
Brian Gesiak | fb66991 | 2017-06-29 18:56:25 +0000 | [diff] [blame] | 340 | should_display_hotness, |
Zachary Turner | 135e942 | 2018-01-05 22:05:13 +0000 | [diff] [blame] | 341 | args.max_hottest_remarks_on_index, |
Brian Gesiak | fb66991 | 2017-06-29 18:56:25 +0000 | [diff] [blame] | 342 | args.jobs, |
| 343 | print_progress) |
Zachary Turner | 135e942 | 2018-01-05 22:05:13 +0000 | [diff] [blame] | 344 | |
| 345 | if __name__ == '__main__': |
| 346 | main() |