Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / grpc-grpc / aa64ddf10962b811e0767b71775d8983ec89cab5 / . / tools / run_tests / run_microbenchmark.py
blob: 2084599e3521c7e9beb025407c378da15b93602b [file] [log] [blame]
Craig Tillerf7af2a92017-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
31import multiprocessing
32import os
33import subprocess
34import sys
Craig Tilleraa64ddf2017-02-08 14:20:08 -0800[diff] [blame^]35import argparse
Craig Tillerf7af2a92017-01-31 15:08:31 -0800[diff] [blame]36
Craig Tiller7dc4ea62017-02-02 16:08:05 -0800[diff] [blame]37import python_utils.jobset as jobset
38import python_utils.start_port_server as start_port_server
39
Craig Tillerf7af2a92017-01-31 15:08:31 -0800[diff] [blame]40flamegraph_dir = os.path.join(os.path.expanduser('~'), 'FlameGraph')
41
Craig Tiller7dc4ea62017-02-02 16:08:05 -0800[diff] [blame]42os.chdir(os.path.join(os.path.dirname(sys.argv[0]), '../..'))
43if not os.path.exists('reports'):
44 os.makedirs('reports')
45
46port_server_port = 32766
47start_port_server.start_port_server(port_server_port)
48
Craig Tillerf7af2a92017-01-31 15:08:31 -0800[diff] [blame]49def fnize(s):
50 out = ''
51 for c in s:
52 if c in '<>, /':
53 if len(out) and out[-1] == '_': continue
54 out += '_'
55 else:
56 out += c
57 return out
58
Craig Tillerf7af2a92017-01-31 15:08:31 -0800[diff] [blame]59# index html
60index_html = """
61<html>
62<head>
63<title>Microbenchmark Results</title>
64</head>
65<body>
66"""
67
68def heading(name):
69 global index_html
70 index_html += "<h1>%s</h1>\n" % name
71
72def link(txt, tgt):
73 global index_html
74 index_html += "<p><a href=\"%s\">%s</a></p>\n" % (tgt, txt)
75
Craig Tilleraa64ddf2017-02-08 14:20:08 -0800[diff] [blame^]76def text(txt):
77 global index_html
78 index_html += "<p><pre>%s</pre></p>" % txt
Craig Tiller7dc4ea62017-02-02 16:08:05 -0800[diff] [blame]79
Craig Tilleraa64ddf2017-02-08 14:20:08 -0800[diff] [blame^]80def collect_latency(bm_name, args):
81 """generate latency profiles"""
82 benchmarks = []
83 profile_analysis = []
84 cleanup = []
85
Craig Tillerf7af2a92017-01-31 15:08:31 -0800[diff] [blame]86 heading('Latency Profiles: %s' % bm_name)
87 subprocess.check_call(
88 ['make', bm_name,
89 'CONFIG=basicprof', '-j', '%d' % multiprocessing.cpu_count()])
90 for line in subprocess.check_output(['bins/basicprof/%s' % bm_name,
91 '--benchmark_list_tests']).splitlines():
Craig Tiller39401792017-02-02 12:22:07 -0800[diff] [blame]92 link(line, '%s.txt' % fnize(line))
Craig Tiller7dc4ea62017-02-02 16:08:05 -0800[diff] [blame]93 benchmarks.append(
94 jobset.JobSpec(['bins/basicprof/%s' % bm_name, '--benchmark_filter=^%s$' % line],
95 environ={'LATENCY_TRACE': '%s.trace' % fnize(line)}))
96 profile_analysis.append(
97 jobset.JobSpec([sys.executable,
98 'tools/profiling/latency_profile/profile_analyzer.py',
99 '--source', '%s.trace' % fnize(line), '--fmt', 'simple',
100 '--out', 'reports/%s.txt' % fnize(line)], timeout_seconds=None))
Craig Tiller715e43b2017-02-07 11:13:16 -0800[diff] [blame]101 cleanup.append(jobset.JobSpec(['rm', '%s.trace' % fnize(line)]))
Craig Tiller360c0d52017-02-08 13:36:44 -0800[diff] [blame]102 # periodically flush out the list of jobs: profile_analysis jobs at least
103 # consume upwards of five gigabytes of ram in some cases, and so analysing
104 # hundreds of them at once is impractical -- but we want at least some
105 # concurrency or the work takes too long
Craig Tillerf74d1722017-02-08 11:38:09 -0800[diff] [blame]106 if len(benchmarks) >= min(4, multiprocessing.cpu_count()):
Craig Tiller360c0d52017-02-08 13:36:44 -0800[diff] [blame]107 # run up to half the cpu count: each benchmark can use up to two cores
108 # (one for the microbenchmark, one for the data flush)
Craig Tiller2ef0d542017-02-08 13:53:18 -0800[diff] [blame]109 jobset.run(benchmarks, maxjobs=max(1, multiprocessing.cpu_count()/2),
Craig Tiller6911d082017-02-07 10:30:44 -0800[diff] [blame]110 add_env={'GRPC_TEST_PORT_SERVER': 'localhost:%d' % port_server_port})
111 jobset.run(profile_analysis, maxjobs=multiprocessing.cpu_count())
112 jobset.run(cleanup, maxjobs=multiprocessing.cpu_count())
113 benchmarks = []
114 profile_analysis = []
115 cleanup = []
Craig Tiller360c0d52017-02-08 13:36:44 -0800[diff] [blame]116 # run the remaining benchmarks that weren't flushed
Craig Tiller6911d082017-02-07 10:30:44 -0800[diff] [blame]117 if len(benchmarks):
Craig Tiller2ef0d542017-02-08 13:53:18 -0800[diff] [blame]118 jobset.run(benchmarks, maxjobs=max(1, multiprocessing.cpu_count()/2),
Craig Tiller6911d082017-02-07 10:30:44 -0800[diff] [blame]119 add_env={'GRPC_TEST_PORT_SERVER': 'localhost:%d' % port_server_port})
120 jobset.run(profile_analysis, maxjobs=multiprocessing.cpu_count())
121 jobset.run(cleanup, maxjobs=multiprocessing.cpu_count())
Craig Tillerf7af2a92017-01-31 15:08:31 -0800[diff] [blame]122
Craig Tilleraa64ddf2017-02-08 14:20:08 -0800[diff] [blame^]123def collect_perf(bm_name, args):
124 """generate flamegraphs"""
Craig Tillerf7af2a92017-01-31 15:08:31 -0800[diff] [blame]125 heading('Flamegraphs: %s' % bm_name)
126 subprocess.check_call(
127 ['make', bm_name,
128 'CONFIG=mutrace', '-j', '%d' % multiprocessing.cpu_count()])
129 for line in subprocess.check_output(['bins/mutrace/%s' % bm_name,
130 '--benchmark_list_tests']).splitlines():
Craig Tiller95ca0172017-02-02 12:27:11 -0800[diff] [blame]131 subprocess.check_call(['sudo', 'perf', 'record', '-g', '-c', '1000',
Craig Tillerf7af2a92017-01-31 15:08:31 -0800[diff] [blame]132 'bins/mutrace/%s' % bm_name,
133 '--benchmark_filter=^%s$' % line,
134 '--benchmark_min_time=20'])
135 with open('/tmp/bm.perf', 'w') as f:
136 f.write(subprocess.check_output(['sudo', 'perf', 'script']))
137 with open('/tmp/bm.folded', 'w') as f:
138 f.write(subprocess.check_output([
139 '%s/stackcollapse-perf.pl' % flamegraph_dir, '/tmp/bm.perf']))
Craig Tiller39401792017-02-02 12:22:07 -0800[diff] [blame]140 link(line, '%s.svg' % fnize(line))
Craig Tillerf7af2a92017-01-31 15:08:31 -0800[diff] [blame]141 with open('reports/%s.svg' % fnize(line), 'w') as f:
142 f.write(subprocess.check_output([
143 '%s/flamegraph.pl' % flamegraph_dir, '/tmp/bm.folded']))
144
Craig Tilleraa64ddf2017-02-08 14:20:08 -0800[diff] [blame^]145def collect_summary(bm_name, args):
146 heading('Summary: %s' % bm_name)
147 subprocess.check_call(
148 ['make', bm_name,
149 'CONFIG=counters', '-j', '%d' % multiprocessing.cpu_count()])
150 text(subprocess.check_output(['bins/counters/%s' % bm_name,
151 '--benchmark_out=out.json',
152 '--benchmark_out_format=json']))
153 if args.bigquery_upload:
154 with open('/tmp/out.csv', 'w') as f:
155 f.write(subprocess.check_output(['tools/profiling/microbenchmarks/bm2bq.py out.json']))
156 subprocess.check_call(['bq', 'load', 'microbenchmarks.microbenchmarks', 'out.csv'])
157
158collectors = {
159 'latency': collect_latency,
160 'perf': collect_perf,
161 'summary': collect_summary,
162}
163
164argp = argparse.ArgumentParser(description='Collect data from microbenchmarks')
165argp.add_argument('-c', '--collect',
166 choices=sorted(collectors.keys()),
167 nargs='+',
168 default=sorted(collectors.keys()),
169 help='Which collectors should be run against each benchmark')
170argp.add_argument('-b', '--benchmarks',
171 default=['bm_fullstack'],
172 nargs='+',
173 type=str,
174 help='Which microbenchmarks should be run')
175argp.add_argument('--bigquery_upload',
176 default=False,
177 action='store_const',
178 const=True,
179 help='Upload results from summary collection to bigquery')
180args = argp.parse_args()
181
182for bm_name in args.benchmarks:
183 for collect in args.collect:
184 collectors[collect](bm_name, args)
185
Craig Tillerf7af2a92017-01-31 15:08:31 -0800[diff] [blame]186index_html += "</body>\n</html>\n"
187with open('reports/index.html', 'w') as f:
Craig Tiller360c0d52017-02-08 13:36:44 -0800[diff] [blame]188 f.write(index_html)