Craig Tiller | f7af2a9 | 2017-01-31 15:08:31 -0800 | [diff] [blame] | 1 | #!/usr/bin/env python2.7 |
| 2 | # Copyright 2017, Google Inc. |
| 3 | # All rights reserved. |
| 4 | # |
| 5 | # Redistribution and use in source and binary forms, with or without |
| 6 | # modification, are permitted provided that the following conditions are |
| 7 | # met: |
| 8 | # |
| 9 | # * Redistributions of source code must retain the above copyright |
| 10 | # notice, this list of conditions and the following disclaimer. |
| 11 | # * Redistributions in binary form must reproduce the above |
| 12 | # copyright notice, this list of conditions and the following disclaimer |
| 13 | # in the documentation and/or other materials provided with the |
| 14 | # distribution. |
| 15 | # * Neither the name of Google Inc. nor the names of its |
| 16 | # contributors may be used to endorse or promote products derived from |
| 17 | # this software without specific prior written permission. |
| 18 | # |
| 19 | # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 20 | # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 21 | # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 22 | # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 23 | # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 24 | # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 25 | # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 26 | # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 27 | # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 28 | # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 29 | # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 30 | |
Craig Tiller | 891e816 | 2017-02-15 23:30:27 -0800 | [diff] [blame] | 31 | import cgi |
Craig Tiller | f7af2a9 | 2017-01-31 15:08:31 -0800 | [diff] [blame] | 32 | import multiprocessing |
| 33 | import os |
| 34 | import subprocess |
| 35 | import sys |
Craig Tiller | aa64ddf | 2017-02-08 14:20:08 -0800 | [diff] [blame] | 36 | import argparse |
Craig Tiller | f7af2a9 | 2017-01-31 15:08:31 -0800 | [diff] [blame] | 37 | |
Craig Tiller | 7dc4ea6 | 2017-02-02 16:08:05 -0800 | [diff] [blame] | 38 | import python_utils.jobset as jobset |
| 39 | import python_utils.start_port_server as start_port_server |
| 40 | |
Craig Tiller | f7af2a9 | 2017-01-31 15:08:31 -0800 | [diff] [blame] | 41 | flamegraph_dir = os.path.join(os.path.expanduser('~'), 'FlameGraph') |
| 42 | |
Craig Tiller | 7dc4ea6 | 2017-02-02 16:08:05 -0800 | [diff] [blame] | 43 | os.chdir(os.path.join(os.path.dirname(sys.argv[0]), '../..')) |
| 44 | if not os.path.exists('reports'): |
| 45 | os.makedirs('reports') |
| 46 | |
| 47 | port_server_port = 32766 |
| 48 | start_port_server.start_port_server(port_server_port) |
| 49 | |
Craig Tiller | f7af2a9 | 2017-01-31 15:08:31 -0800 | [diff] [blame] | 50 | def fnize(s): |
| 51 | out = '' |
| 52 | for c in s: |
| 53 | if c in '<>, /': |
| 54 | if len(out) and out[-1] == '_': continue |
| 55 | out += '_' |
| 56 | else: |
| 57 | out += c |
| 58 | return out |
| 59 | |
Craig Tiller | f7af2a9 | 2017-01-31 15:08:31 -0800 | [diff] [blame] | 60 | # index html |
| 61 | index_html = """ |
| 62 | <html> |
| 63 | <head> |
| 64 | <title>Microbenchmark Results</title> |
| 65 | </head> |
| 66 | <body> |
| 67 | """ |
| 68 | |
| 69 | def heading(name): |
| 70 | global index_html |
| 71 | index_html += "<h1>%s</h1>\n" % name |
| 72 | |
| 73 | def link(txt, tgt): |
| 74 | global index_html |
Craig Tiller | 891e816 | 2017-02-15 23:30:27 -0800 | [diff] [blame] | 75 | index_html += "<p><a href=\"%s\">%s</a></p>\n" % ( |
| 76 | cgi.escape(tgt, quote=True), cgi.escape(txt)) |
Craig Tiller | f7af2a9 | 2017-01-31 15:08:31 -0800 | [diff] [blame] | 77 | |
Craig Tiller | aa64ddf | 2017-02-08 14:20:08 -0800 | [diff] [blame] | 78 | def text(txt): |
| 79 | global index_html |
Craig Tiller | 891e816 | 2017-02-15 23:30:27 -0800 | [diff] [blame] | 80 | index_html += "<p><pre>%s</pre></p>\n" % cgi.escape(txt) |
Craig Tiller | 7dc4ea6 | 2017-02-02 16:08:05 -0800 | [diff] [blame] | 81 | |
Craig Tiller | aa64ddf | 2017-02-08 14:20:08 -0800 | [diff] [blame] | 82 | def collect_latency(bm_name, args): |
| 83 | """generate latency profiles""" |
| 84 | benchmarks = [] |
| 85 | profile_analysis = [] |
| 86 | cleanup = [] |
| 87 | |
Craig Tiller | f7af2a9 | 2017-01-31 15:08:31 -0800 | [diff] [blame] | 88 | heading('Latency Profiles: %s' % bm_name) |
| 89 | subprocess.check_call( |
| 90 | ['make', bm_name, |
| 91 | 'CONFIG=basicprof', '-j', '%d' % multiprocessing.cpu_count()]) |
| 92 | for line in subprocess.check_output(['bins/basicprof/%s' % bm_name, |
| 93 | '--benchmark_list_tests']).splitlines(): |
Craig Tiller | 3940179 | 2017-02-02 12:22:07 -0800 | [diff] [blame] | 94 | link(line, '%s.txt' % fnize(line)) |
Craig Tiller | 7dc4ea6 | 2017-02-02 16:08:05 -0800 | [diff] [blame] | 95 | benchmarks.append( |
Craig Tiller | ece502f | 2017-02-17 16:20:50 -0800 | [diff] [blame] | 96 | jobset.JobSpec(['bins/basicprof/%s' % bm_name, |
| 97 | '--benchmark_filter=^%s$' % line, |
| 98 | '--benchmark_min_time=0.05'], |
Craig Tiller | 7dc4ea6 | 2017-02-02 16:08:05 -0800 | [diff] [blame] | 99 | environ={'LATENCY_TRACE': '%s.trace' % fnize(line)})) |
| 100 | profile_analysis.append( |
| 101 | jobset.JobSpec([sys.executable, |
| 102 | 'tools/profiling/latency_profile/profile_analyzer.py', |
| 103 | '--source', '%s.trace' % fnize(line), '--fmt', 'simple', |
| 104 | '--out', 'reports/%s.txt' % fnize(line)], timeout_seconds=None)) |
Craig Tiller | 715e43b | 2017-02-07 11:13:16 -0800 | [diff] [blame] | 105 | cleanup.append(jobset.JobSpec(['rm', '%s.trace' % fnize(line)])) |
Craig Tiller | 360c0d5 | 2017-02-08 13:36:44 -0800 | [diff] [blame] | 106 | # periodically flush out the list of jobs: profile_analysis jobs at least |
| 107 | # consume upwards of five gigabytes of ram in some cases, and so analysing |
| 108 | # hundreds of them at once is impractical -- but we want at least some |
| 109 | # concurrency or the work takes too long |
Craig Tiller | ece502f | 2017-02-17 16:20:50 -0800 | [diff] [blame] | 110 | if len(benchmarks) >= min(16, multiprocessing.cpu_count()): |
Craig Tiller | 360c0d5 | 2017-02-08 13:36:44 -0800 | [diff] [blame] | 111 | # run up to half the cpu count: each benchmark can use up to two cores |
| 112 | # (one for the microbenchmark, one for the data flush) |
Craig Tiller | 2ef0d54 | 2017-02-08 13:53:18 -0800 | [diff] [blame] | 113 | jobset.run(benchmarks, maxjobs=max(1, multiprocessing.cpu_count()/2), |
Craig Tiller | 6911d08 | 2017-02-07 10:30:44 -0800 | [diff] [blame] | 114 | add_env={'GRPC_TEST_PORT_SERVER': 'localhost:%d' % port_server_port}) |
| 115 | jobset.run(profile_analysis, maxjobs=multiprocessing.cpu_count()) |
| 116 | jobset.run(cleanup, maxjobs=multiprocessing.cpu_count()) |
| 117 | benchmarks = [] |
| 118 | profile_analysis = [] |
| 119 | cleanup = [] |
Craig Tiller | 360c0d5 | 2017-02-08 13:36:44 -0800 | [diff] [blame] | 120 | # run the remaining benchmarks that weren't flushed |
Craig Tiller | 6911d08 | 2017-02-07 10:30:44 -0800 | [diff] [blame] | 121 | if len(benchmarks): |
Craig Tiller | 2ef0d54 | 2017-02-08 13:53:18 -0800 | [diff] [blame] | 122 | jobset.run(benchmarks, maxjobs=max(1, multiprocessing.cpu_count()/2), |
Craig Tiller | 6911d08 | 2017-02-07 10:30:44 -0800 | [diff] [blame] | 123 | add_env={'GRPC_TEST_PORT_SERVER': 'localhost:%d' % port_server_port}) |
| 124 | jobset.run(profile_analysis, maxjobs=multiprocessing.cpu_count()) |
| 125 | jobset.run(cleanup, maxjobs=multiprocessing.cpu_count()) |
Craig Tiller | f7af2a9 | 2017-01-31 15:08:31 -0800 | [diff] [blame] | 126 | |
Craig Tiller | aa64ddf | 2017-02-08 14:20:08 -0800 | [diff] [blame] | 127 | def collect_perf(bm_name, args): |
| 128 | """generate flamegraphs""" |
Craig Tiller | f7af2a9 | 2017-01-31 15:08:31 -0800 | [diff] [blame] | 129 | heading('Flamegraphs: %s' % bm_name) |
| 130 | subprocess.check_call( |
| 131 | ['make', bm_name, |
| 132 | 'CONFIG=mutrace', '-j', '%d' % multiprocessing.cpu_count()]) |
Craig Tiller | 6ad0072 | 2017-02-15 09:14:24 -0800 | [diff] [blame] | 133 | benchmarks = [] |
| 134 | profile_analysis = [] |
| 135 | cleanup = [] |
Craig Tiller | f7af2a9 | 2017-01-31 15:08:31 -0800 | [diff] [blame] | 136 | for line in subprocess.check_output(['bins/mutrace/%s' % bm_name, |
| 137 | '--benchmark_list_tests']).splitlines(): |
Craig Tiller | 5a8c586 | 2017-02-15 07:59:05 -0800 | [diff] [blame] | 138 | link(line, '%s.svg' % fnize(line)) |
Craig Tiller | 6ad0072 | 2017-02-15 09:14:24 -0800 | [diff] [blame] | 139 | benchmarks.append( |
| 140 | jobset.JobSpec(['perf', 'record', '-o', '%s-perf.data' % fnize(line), |
Craig Tiller | c2c0c6f | 2017-02-15 11:27:37 -0800 | [diff] [blame] | 141 | '-g', '-F', '997', |
Craig Tiller | 6ad0072 | 2017-02-15 09:14:24 -0800 | [diff] [blame] | 142 | 'bins/mutrace/%s' % bm_name, |
| 143 | '--benchmark_filter=^%s$' % line, |
| 144 | '--benchmark_min_time=10'])) |
| 145 | profile_analysis.append( |
| 146 | jobset.JobSpec(['tools/run_tests/performance/process_local_perf_flamegraphs.sh'], |
| 147 | environ = { |
| 148 | 'PERF_BASE_NAME': fnize(line), |
| 149 | 'OUTPUT_DIR': 'reports', |
| 150 | 'OUTPUT_FILENAME': fnize(line), |
| 151 | })) |
| 152 | cleanup.append(jobset.JobSpec(['rm', '%s-perf.data' % fnize(line)])) |
| 153 | cleanup.append(jobset.JobSpec(['rm', '%s-out.perf' % fnize(line)])) |
| 154 | # periodically flush out the list of jobs: temporary space required for this |
| 155 | # processing is large |
| 156 | if len(benchmarks) >= 20: |
| 157 | # run up to half the cpu count: each benchmark can use up to two cores |
| 158 | # (one for the microbenchmark, one for the data flush) |
Craig Tiller | ab95194 | 2017-02-15 11:26:54 -0800 | [diff] [blame] | 159 | jobset.run(benchmarks, maxjobs=1, |
Craig Tiller | 6ad0072 | 2017-02-15 09:14:24 -0800 | [diff] [blame] | 160 | add_env={'GRPC_TEST_PORT_SERVER': 'localhost:%d' % port_server_port}) |
| 161 | jobset.run(profile_analysis, maxjobs=multiprocessing.cpu_count()) |
| 162 | jobset.run(cleanup, maxjobs=multiprocessing.cpu_count()) |
| 163 | benchmarks = [] |
| 164 | profile_analysis = [] |
| 165 | cleanup = [] |
| 166 | # run the remaining benchmarks that weren't flushed |
| 167 | if len(benchmarks): |
Craig Tiller | ab95194 | 2017-02-15 11:26:54 -0800 | [diff] [blame] | 168 | jobset.run(benchmarks, maxjobs=1, |
Craig Tiller | 6ad0072 | 2017-02-15 09:14:24 -0800 | [diff] [blame] | 169 | add_env={'GRPC_TEST_PORT_SERVER': 'localhost:%d' % port_server_port}) |
| 170 | jobset.run(profile_analysis, maxjobs=multiprocessing.cpu_count()) |
| 171 | jobset.run(cleanup, maxjobs=multiprocessing.cpu_count()) |
Craig Tiller | f7af2a9 | 2017-01-31 15:08:31 -0800 | [diff] [blame] | 172 | |
Craig Tiller | aa64ddf | 2017-02-08 14:20:08 -0800 | [diff] [blame] | 173 | def collect_summary(bm_name, args): |
| 174 | heading('Summary: %s' % bm_name) |
| 175 | subprocess.check_call( |
| 176 | ['make', bm_name, |
| 177 | 'CONFIG=counters', '-j', '%d' % multiprocessing.cpu_count()]) |
Craig Tiller | d9bc210 | 2017-02-15 08:24:55 -0800 | [diff] [blame] | 178 | cmd = ['bins/counters/%s' % bm_name, |
| 179 | '--benchmark_out=out.json', |
| 180 | '--benchmark_out_format=json'] |
| 181 | if args.summary_time is not None: |
| 182 | cmd += ['--benchmark_min_time=%d' % args.summary_time] |
| 183 | text(subprocess.check_output(cmd)) |
Craig Tiller | aa64ddf | 2017-02-08 14:20:08 -0800 | [diff] [blame] | 184 | if args.bigquery_upload: |
Craig Tiller | d12731e | 2017-02-13 12:41:27 -0800 | [diff] [blame] | 185 | with open('out.csv', 'w') as f: |
Craig Tiller | fc4f72a | 2017-02-08 15:57:03 -0800 | [diff] [blame] | 186 | f.write(subprocess.check_output(['tools/profiling/microbenchmarks/bm2bq.py', 'out.json'])) |
Craig Tiller | aa64ddf | 2017-02-08 14:20:08 -0800 | [diff] [blame] | 187 | subprocess.check_call(['bq', 'load', 'microbenchmarks.microbenchmarks', 'out.csv']) |
| 188 | |
| 189 | collectors = { |
| 190 | 'latency': collect_latency, |
| 191 | 'perf': collect_perf, |
| 192 | 'summary': collect_summary, |
| 193 | } |
| 194 | |
| 195 | argp = argparse.ArgumentParser(description='Collect data from microbenchmarks') |
| 196 | argp.add_argument('-c', '--collect', |
| 197 | choices=sorted(collectors.keys()), |
| 198 | nargs='+', |
| 199 | default=sorted(collectors.keys()), |
| 200 | help='Which collectors should be run against each benchmark') |
| 201 | argp.add_argument('-b', '--benchmarks', |
Craig Tiller | 523d54b | 2017-02-23 08:52:38 -0800 | [diff] [blame] | 202 | default=['bm_fullstack', |
| 203 | 'bm_closure', |
| 204 | 'bm_cq', |
| 205 | 'bm_call_create', |
| 206 | 'bm_error', |
Craig Tiller | 510f38a | 2017-02-24 17:00:19 -0800 | [diff] [blame] | 207 | 'bm_chttp2_hpack', |
| 208 | 'bm_metadata'], |
Craig Tiller | aa64ddf | 2017-02-08 14:20:08 -0800 | [diff] [blame] | 209 | nargs='+', |
| 210 | type=str, |
| 211 | help='Which microbenchmarks should be run') |
Craig Tiller | d753f45 | 2017-03-01 14:00:35 -0800 | [diff] [blame^] | 212 | argp.add_argument('--diff_perf', |
| 213 | default=None, |
| 214 | type=str, |
| 215 | help='Diff microbenchmarks against this git revision') |
Craig Tiller | aa64ddf | 2017-02-08 14:20:08 -0800 | [diff] [blame] | 216 | argp.add_argument('--bigquery_upload', |
| 217 | default=False, |
| 218 | action='store_const', |
| 219 | const=True, |
| 220 | help='Upload results from summary collection to bigquery') |
Craig Tiller | d9bc210 | 2017-02-15 08:24:55 -0800 | [diff] [blame] | 221 | argp.add_argument('--summary_time', |
| 222 | default=None, |
| 223 | type=int, |
| 224 | help='Minimum time to run benchmarks for the summary collection') |
Craig Tiller | aa64ddf | 2017-02-08 14:20:08 -0800 | [diff] [blame] | 225 | args = argp.parse_args() |
| 226 | |
| 227 | for bm_name in args.benchmarks: |
| 228 | for collect in args.collect: |
| 229 | collectors[collect](bm_name, args) |
Craig Tiller | d753f45 | 2017-03-01 14:00:35 -0800 | [diff] [blame^] | 230 | if args.diff_perf: |
| 231 | pass |
| 232 | |
Craig Tiller | aa64ddf | 2017-02-08 14:20:08 -0800 | [diff] [blame] | 233 | |
Craig Tiller | f7af2a9 | 2017-01-31 15:08:31 -0800 | [diff] [blame] | 234 | index_html += "</body>\n</html>\n" |
| 235 | with open('reports/index.html', 'w') as f: |
Craig Tiller | 360c0d5 | 2017-02-08 13:36:44 -0800 | [diff] [blame] | 236 | f.write(index_html) |