Jamie Gennis | 9279147 | 2012-03-05 17:33:58 -0800 | [diff] [blame] | 1 | #!/usr/bin/env python |
| 2 | |
Jamie Gennis | 4b56a2b | 2012-04-28 01:06:56 -0700 | [diff] [blame] | 3 | # Copyright (c) 2011 The Chromium Authors. All rights reserved. |
| 4 | # Use of this source code is governed by a BSD-style license that can be |
| 5 | # found in the LICENSE file. |
Jamie Gennis | 9279147 | 2012-03-05 17:33:58 -0800 | [diff] [blame] | 6 | |
| 7 | """Android system-wide tracing utility. |
| 8 | |
| 9 | This is a tool for capturing a trace that includes data from both userland and |
| 10 | the kernel. It creates an HTML file for visualizing the trace. |
| 11 | """ |
| 12 | |
Jamie Gennis | 2da489c | 2012-09-19 18:06:29 -0700 | [diff] [blame] | 13 | import errno, optparse, os, select, subprocess, sys, time, zlib |
Jamie Gennis | 9279147 | 2012-03-05 17:33:58 -0800 | [diff] [blame] | 14 | |
Jamie Gennis | 7e3783f | 2012-04-28 13:16:11 -0700 | [diff] [blame] | 15 | # This list is based on the tags in frameworks/native/include/utils/Trace.h. |
| 16 | trace_tag_bits = { |
| 17 | 'gfx': 1<<1, |
| 18 | 'input': 1<<2, |
| 19 | 'view': 1<<3, |
| 20 | 'webview': 1<<4, |
| 21 | 'wm': 1<<5, |
| 22 | 'am': 1<<6, |
Andy Stadler | 5bd161f | 2012-05-03 15:31:03 -0700 | [diff] [blame] | 23 | 'sync': 1<<7, |
Glenn Kasten | b4fa51e | 2012-05-07 09:19:32 -0700 | [diff] [blame] | 24 | 'audio': 1<<8, |
Jamie Gennis | b7f480d | 2012-05-11 04:44:03 -0700 | [diff] [blame] | 25 | 'video': 1<<9, |
Eino-Ville Talvala | da77298 | 2012-05-31 15:49:57 -0700 | [diff] [blame] | 26 | 'camera': 1<<10, |
Jamie Gennis | 7e3783f | 2012-04-28 13:16:11 -0700 | [diff] [blame] | 27 | } |
| 28 | |
Jamie Gennis | 2da489c | 2012-09-19 18:06:29 -0700 | [diff] [blame] | 29 | flattened_css_file = 'style.css' |
| 30 | flattened_js_file = 'script.js' |
| 31 | |
Keun young Park | de427be | 2012-08-30 15:17:13 -0700 | [diff] [blame] | 32 | def add_adb_serial(command, serial): |
| 33 | if serial != None: |
| 34 | command.insert(1, serial) |
| 35 | command.insert(1, '-s') |
| 36 | |
Jamie Gennis | 9279147 | 2012-03-05 17:33:58 -0800 | [diff] [blame] | 37 | def main(): |
| 38 | parser = optparse.OptionParser() |
| 39 | parser.add_option('-o', dest='output_file', help='write HTML to FILE', |
| 40 | default='trace.html', metavar='FILE') |
| 41 | parser.add_option('-t', '--time', dest='trace_time', type='int', |
| 42 | help='trace for N seconds', metavar='N') |
Jamie Gennis | 98ef97d | 2012-03-07 16:06:53 -0800 | [diff] [blame] | 43 | parser.add_option('-b', '--buf-size', dest='trace_buf_size', type='int', |
| 44 | help='use a trace buffer size of N KB', metavar='N') |
Jeff Brown | a4d8b28 | 2012-05-22 18:56:09 -0700 | [diff] [blame] | 45 | parser.add_option('-d', '--disk', dest='trace_disk', default=False, |
Jamie Gennis | 1f5d4e9 | 2012-06-07 16:59:27 -0700 | [diff] [blame] | 46 | action='store_true', help='trace disk I/O (requires root)') |
Jamie Gennis | 98ef97d | 2012-03-07 16:06:53 -0800 | [diff] [blame] | 47 | parser.add_option('-f', '--cpu-freq', dest='trace_cpu_freq', default=False, |
| 48 | action='store_true', help='trace CPU frequency changes') |
Jamie Gennis | 415e5d8 | 2012-05-07 18:00:11 -0700 | [diff] [blame] | 49 | parser.add_option('-i', '--cpu-idle', dest='trace_cpu_idle', default=False, |
| 50 | action='store_true', help='trace CPU idle events') |
Jamie Gennis | 98ef97d | 2012-03-07 16:06:53 -0800 | [diff] [blame] | 51 | parser.add_option('-l', '--cpu-load', dest='trace_cpu_load', default=False, |
| 52 | action='store_true', help='trace CPU load') |
Andy Stadler | 5bd161f | 2012-05-03 15:31:03 -0700 | [diff] [blame] | 53 | parser.add_option('-s', '--no-cpu-sched', dest='trace_cpu_sched', default=True, |
| 54 | action='store_false', help='inhibit tracing CPU ' + |
| 55 | 'scheduler (allows longer trace times by reducing data ' + |
| 56 | 'rate into buffer)') |
Erik Gilling | 37100a8 | 2012-10-04 15:57:13 -0700 | [diff] [blame^] | 57 | parser.add_option('-u', '--bus-utilization', dest='trace_bus_utilization', |
| 58 | default=False, action='store_true', |
| 59 | help='trace bus utilization (requires root)') |
Jamie Gennis | 9279147 | 2012-03-05 17:33:58 -0800 | [diff] [blame] | 60 | parser.add_option('-w', '--workqueue', dest='trace_workqueue', default=False, |
Jamie Gennis | 1f5d4e9 | 2012-06-07 16:59:27 -0700 | [diff] [blame] | 61 | action='store_true', help='trace the kernel workqueues ' + |
| 62 | '(requires root)') |
Jamie Gennis | 7e3783f | 2012-04-28 13:16:11 -0700 | [diff] [blame] | 63 | parser.add_option('--set-tags', dest='set_tags', action='store', |
| 64 | help='set the enabled trace tags and exit; set to a ' + |
| 65 | 'comma separated list of: ' + |
| 66 | ', '.join(trace_tag_bits.iterkeys())) |
Jeff Brown | 595ae1e | 2012-05-22 14:52:13 -0700 | [diff] [blame] | 67 | parser.add_option('--link-assets', dest='link_assets', default=False, |
| 68 | action='store_true', help='link to original CSS or JS resources ' |
| 69 | 'instead of embedding them') |
Jamie Gennis | 2da489c | 2012-09-19 18:06:29 -0700 | [diff] [blame] | 70 | parser.add_option('--asset-dir', dest='asset_dir', default='trace-viewer', |
| 71 | type='string', help='') |
Keun young Park | de427be | 2012-08-30 15:17:13 -0700 | [diff] [blame] | 72 | parser.add_option('-e', '--serial', dest='device_serial', type='string', |
| 73 | help='adb device serial number') |
Jamie Gennis | 9279147 | 2012-03-05 17:33:58 -0800 | [diff] [blame] | 74 | options, args = parser.parse_args() |
| 75 | |
Jamie Gennis | 7e3783f | 2012-04-28 13:16:11 -0700 | [diff] [blame] | 76 | if options.set_tags: |
| 77 | flags = 0 |
| 78 | tags = options.set_tags.split(',') |
| 79 | for tag in tags: |
| 80 | try: |
| 81 | flags |= trace_tag_bits[tag] |
| 82 | except KeyError: |
| 83 | parser.error('unrecognized tag: %s\nknown tags are: %s' % |
| 84 | (tag, ', '.join(trace_tag_bits.iterkeys()))) |
Jamie Gennis | 81e9aa7 | 2012-05-09 13:57:58 -0700 | [diff] [blame] | 85 | atrace_args = ['adb', 'shell', 'setprop', 'debug.atrace.tags.enableflags', hex(flags)] |
Keun young Park | de427be | 2012-08-30 15:17:13 -0700 | [diff] [blame] | 86 | add_adb_serial(atrace_args, options.device_serial) |
Jamie Gennis | 7e3783f | 2012-04-28 13:16:11 -0700 | [diff] [blame] | 87 | try: |
| 88 | subprocess.check_call(atrace_args) |
| 89 | except subprocess.CalledProcessError, e: |
Jamie Gennis | 1f5d4e9 | 2012-06-07 16:59:27 -0700 | [diff] [blame] | 90 | print >> sys.stderr, 'unable to set tags: %s' % e |
Jamie Gennis | 7e3783f | 2012-04-28 13:16:11 -0700 | [diff] [blame] | 91 | print '\nSet enabled tags to: %s\n' % ', '.join(tags) |
| 92 | print ('You will likely need to restart the Android framework for this to ' + |
| 93 | 'take effect:\n\n adb shell stop\n adb shell ' + |
| 94 | 'start\n') |
| 95 | return |
| 96 | |
Andy Stadler | 5bd161f | 2012-05-03 15:31:03 -0700 | [diff] [blame] | 97 | atrace_args = ['adb', 'shell', 'atrace', '-z'] |
Keun young Park | de427be | 2012-08-30 15:17:13 -0700 | [diff] [blame] | 98 | add_adb_serial(atrace_args, options.device_serial) |
| 99 | |
Jeff Brown | a4d8b28 | 2012-05-22 18:56:09 -0700 | [diff] [blame] | 100 | if options.trace_disk: |
| 101 | atrace_args.append('-d') |
Jamie Gennis | 98ef97d | 2012-03-07 16:06:53 -0800 | [diff] [blame] | 102 | if options.trace_cpu_freq: |
| 103 | atrace_args.append('-f') |
Jamie Gennis | 415e5d8 | 2012-05-07 18:00:11 -0700 | [diff] [blame] | 104 | if options.trace_cpu_idle: |
| 105 | atrace_args.append('-i') |
Jamie Gennis | 98ef97d | 2012-03-07 16:06:53 -0800 | [diff] [blame] | 106 | if options.trace_cpu_load: |
| 107 | atrace_args.append('-l') |
Andy Stadler | 5bd161f | 2012-05-03 15:31:03 -0700 | [diff] [blame] | 108 | if options.trace_cpu_sched: |
| 109 | atrace_args.append('-s') |
Erik Gilling | 37100a8 | 2012-10-04 15:57:13 -0700 | [diff] [blame^] | 110 | if options.trace_bus_utilization: |
| 111 | atrace_args.append('-u') |
Jamie Gennis | 9279147 | 2012-03-05 17:33:58 -0800 | [diff] [blame] | 112 | if options.trace_workqueue: |
| 113 | atrace_args.append('-w') |
| 114 | if options.trace_time is not None: |
| 115 | if options.trace_time > 0: |
| 116 | atrace_args.extend(['-t', str(options.trace_time)]) |
| 117 | else: |
| 118 | parser.error('the trace time must be a positive number') |
Jamie Gennis | 98ef97d | 2012-03-07 16:06:53 -0800 | [diff] [blame] | 119 | if options.trace_buf_size is not None: |
| 120 | if options.trace_buf_size > 0: |
| 121 | atrace_args.extend(['-b', str(options.trace_buf_size)]) |
| 122 | else: |
| 123 | parser.error('the trace buffer size must be a positive number') |
Jamie Gennis | 9279147 | 2012-03-05 17:33:58 -0800 | [diff] [blame] | 124 | |
Jamie Gennis | 4b56a2b | 2012-04-28 01:06:56 -0700 | [diff] [blame] | 125 | script_dir = os.path.dirname(os.path.abspath(sys.argv[0])) |
Jeff Brown | 595ae1e | 2012-05-22 14:52:13 -0700 | [diff] [blame] | 126 | |
| 127 | if options.link_assets: |
Jamie Gennis | 2da489c | 2012-09-19 18:06:29 -0700 | [diff] [blame] | 128 | src_dir = os.path.join(script_dir, options.asset_dir, 'src') |
| 129 | build_dir = os.path.join(script_dir, options.asset_dir, 'build') |
| 130 | |
| 131 | js_files, js_flattenizer, css_files = get_assets(src_dir, build_dir) |
| 132 | |
| 133 | css = '\n'.join(linked_css_tag % (os.path.join(src_dir, f)) for f in css_files) |
| 134 | js = '<script language="javascript">\n%s</script>\n' % js_flattenizer |
| 135 | js += '\n'.join(linked_js_tag % (os.path.join(src_dir, f)) for f in js_files) |
Jeff Brown | 595ae1e | 2012-05-22 14:52:13 -0700 | [diff] [blame] | 136 | else: |
Jamie Gennis | 2da489c | 2012-09-19 18:06:29 -0700 | [diff] [blame] | 137 | css_filename = os.path.join(script_dir, flattened_css_file) |
| 138 | js_filename = os.path.join(script_dir, flattened_js_file) |
Jeff Brown | 595ae1e | 2012-05-22 14:52:13 -0700 | [diff] [blame] | 139 | css = compiled_css_tag % (open(css_filename).read()) |
| 140 | js = compiled_js_tag % (open(js_filename).read()) |
Jamie Gennis | 4b56a2b | 2012-04-28 01:06:56 -0700 | [diff] [blame] | 141 | |
Jamie Gennis | 9279147 | 2012-03-05 17:33:58 -0800 | [diff] [blame] | 142 | html_filename = options.output_file |
Jamie Gennis | 9279147 | 2012-03-05 17:33:58 -0800 | [diff] [blame] | 143 | |
| 144 | trace_started = False |
Jamie Gennis | 1bf4a49 | 2012-03-13 18:07:36 -0700 | [diff] [blame] | 145 | leftovers = '' |
| 146 | adb = subprocess.Popen(atrace_args, stdout=subprocess.PIPE, |
Jamie Gennis | 7e3783f | 2012-04-28 13:16:11 -0700 | [diff] [blame] | 147 | stderr=subprocess.PIPE) |
Jamie Gennis | bf3e616 | 2012-04-28 19:16:49 -0700 | [diff] [blame] | 148 | dec = zlib.decompressobj() |
Jamie Gennis | 9279147 | 2012-03-05 17:33:58 -0800 | [diff] [blame] | 149 | while True: |
Jamie Gennis | 1bf4a49 | 2012-03-13 18:07:36 -0700 | [diff] [blame] | 150 | ready = select.select([adb.stdout, adb.stderr], [], [adb.stdout, adb.stderr]) |
| 151 | if adb.stderr in ready[0]: |
| 152 | err = os.read(adb.stderr.fileno(), 4096) |
| 153 | sys.stderr.write(err) |
| 154 | sys.stderr.flush() |
| 155 | if adb.stdout in ready[0]: |
Jamie Gennis | bf3e616 | 2012-04-28 19:16:49 -0700 | [diff] [blame] | 156 | out = leftovers + os.read(adb.stdout.fileno(), 4096) |
| 157 | out = out.replace('\r\n', '\n') |
| 158 | if out.endswith('\r'): |
| 159 | out = out[:-1] |
| 160 | leftovers = '\r' |
| 161 | else: |
| 162 | leftovers = '' |
Jamie Gennis | 9279147 | 2012-03-05 17:33:58 -0800 | [diff] [blame] | 163 | if not trace_started: |
Jamie Gennis | 1bf4a49 | 2012-03-13 18:07:36 -0700 | [diff] [blame] | 164 | lines = out.splitlines(True) |
Jamie Gennis | bf3e616 | 2012-04-28 19:16:49 -0700 | [diff] [blame] | 165 | out = '' |
Jamie Gennis | 9279147 | 2012-03-05 17:33:58 -0800 | [diff] [blame] | 166 | for i, line in enumerate(lines): |
Jamie Gennis | bf3e616 | 2012-04-28 19:16:49 -0700 | [diff] [blame] | 167 | if line == 'TRACE:\n': |
Jamie Gennis | 1bf4a49 | 2012-03-13 18:07:36 -0700 | [diff] [blame] | 168 | sys.stdout.write("downloading trace...") |
Jamie Gennis | 9279147 | 2012-03-05 17:33:58 -0800 | [diff] [blame] | 169 | sys.stdout.flush() |
Jamie Gennis | 1bf4a49 | 2012-03-13 18:07:36 -0700 | [diff] [blame] | 170 | out = ''.join(lines[i+1:]) |
Jamie Gennis | 1f5d4e9 | 2012-06-07 16:59:27 -0700 | [diff] [blame] | 171 | html_file = open(html_filename, 'w') |
| 172 | html_file.write(html_prefix % (css, js)) |
Jamie Gennis | 9279147 | 2012-03-05 17:33:58 -0800 | [diff] [blame] | 173 | trace_started = True |
| 174 | break |
Jamie Gennis | 1bf4a49 | 2012-03-13 18:07:36 -0700 | [diff] [blame] | 175 | elif 'TRACE:'.startswith(line) and i == len(lines) - 1: |
Jamie Gennis | bf3e616 | 2012-04-28 19:16:49 -0700 | [diff] [blame] | 176 | leftovers = line + leftovers |
Jamie Gennis | 9279147 | 2012-03-05 17:33:58 -0800 | [diff] [blame] | 177 | else: |
Jamie Gennis | 1bf4a49 | 2012-03-13 18:07:36 -0700 | [diff] [blame] | 178 | sys.stdout.write(line) |
Jamie Gennis | 9279147 | 2012-03-05 17:33:58 -0800 | [diff] [blame] | 179 | sys.stdout.flush() |
Jamie Gennis | bf3e616 | 2012-04-28 19:16:49 -0700 | [diff] [blame] | 180 | if len(out) > 0: |
| 181 | out = dec.decompress(out) |
| 182 | html_out = out.replace('\n', '\\n\\\n') |
Jamie Gennis | 1bf4a49 | 2012-03-13 18:07:36 -0700 | [diff] [blame] | 183 | if len(html_out) > 0: |
| 184 | html_file.write(html_out) |
| 185 | result = adb.poll() |
Jamie Gennis | 9279147 | 2012-03-05 17:33:58 -0800 | [diff] [blame] | 186 | if result is not None: |
| 187 | break |
| 188 | if result != 0: |
Jamie Gennis | 1f5d4e9 | 2012-06-07 16:59:27 -0700 | [diff] [blame] | 189 | print >> sys.stderr, 'adb returned error code %d' % result |
| 190 | elif trace_started: |
Jamie Gennis | bf3e616 | 2012-04-28 19:16:49 -0700 | [diff] [blame] | 191 | html_out = dec.flush().replace('\n', '\\n\\\n').replace('\r', '') |
| 192 | if len(html_out) > 0: |
| 193 | html_file.write(html_out) |
Jamie Gennis | 9279147 | 2012-03-05 17:33:58 -0800 | [diff] [blame] | 194 | html_file.write(html_suffix) |
| 195 | html_file.close() |
Jamie Gennis | 1bf4a49 | 2012-03-13 18:07:36 -0700 | [diff] [blame] | 196 | print " done\n\n wrote file://%s/%s\n" % (os.getcwd(), options.output_file) |
Jamie Gennis | 1f5d4e9 | 2012-06-07 16:59:27 -0700 | [diff] [blame] | 197 | else: |
| 198 | print >> sys.stderr, ('An error occured while capturing the trace. Output ' + |
| 199 | 'file was not written.') |
Jamie Gennis | 9279147 | 2012-03-05 17:33:58 -0800 | [diff] [blame] | 200 | |
Jamie Gennis | 2da489c | 2012-09-19 18:06:29 -0700 | [diff] [blame] | 201 | def get_assets(src_dir, build_dir): |
| 202 | sys.path.append(build_dir) |
| 203 | gen = __import__('generate_standalone_timeline_view', {}, {}) |
| 204 | parse_deps = __import__('parse_deps', {}, {}) |
| 205 | filenames = gen._get_input_filenames() |
| 206 | load_sequence = parse_deps.calc_load_sequence(filenames) |
| 207 | |
| 208 | js_files = [] |
| 209 | js_flattenizer = "window.FLATTENED = {};\n" |
| 210 | css_files = [] |
| 211 | |
| 212 | for module in load_sequence: |
| 213 | js_files.append(os.path.relpath(module.filename, src_dir)) |
| 214 | js_flattenizer += "window.FLATTENED['%s'] = true;\n" % module.name |
| 215 | for style_sheet in module.style_sheets: |
| 216 | css_files.append(os.path.relpath(style_sheet.filename, src_dir)) |
| 217 | |
| 218 | sys.path.pop() |
| 219 | |
| 220 | return (js_files, js_flattenizer, css_files) |
| 221 | |
Jamie Gennis | 9279147 | 2012-03-05 17:33:58 -0800 | [diff] [blame] | 222 | html_prefix = """<!DOCTYPE HTML> |
| 223 | <html> |
| 224 | <head i18n-values="dir:textdirection;"> |
| 225 | <title>Android System Trace</title> |
Jeff Brown | 595ae1e | 2012-05-22 14:52:13 -0700 | [diff] [blame] | 226 | %s |
| 227 | %s |
Jamie Gennis | 2da489c | 2012-09-19 18:06:29 -0700 | [diff] [blame] | 228 | <script language="javascript"> |
| 229 | document.addEventListener('DOMContentLoaded', function() { |
| 230 | if (!linuxPerfData) |
| 231 | return; |
| 232 | |
| 233 | var m = new tracing.TimelineModel(linuxPerfData); |
| 234 | var timelineViewEl = document.querySelector('.view'); |
| 235 | base.ui.decorate(timelineViewEl, tracing.TimelineView); |
| 236 | timelineViewEl.model = m; |
| 237 | timelineViewEl.tabIndex = 1; |
| 238 | timelineViewEl.timeline.focusElement = timelineViewEl; |
| 239 | }); |
| 240 | </script> |
Jamie Gennis | 9279147 | 2012-03-05 17:33:58 -0800 | [diff] [blame] | 241 | <style> |
| 242 | .view { |
| 243 | overflow: hidden; |
| 244 | position: absolute; |
| 245 | top: 0; |
| 246 | bottom: 0; |
| 247 | left: 0; |
| 248 | right: 0; |
| 249 | } |
| 250 | </style> |
| 251 | </head> |
| 252 | <body> |
| 253 | <div class="view"> |
| 254 | </div> |
Jamie Gennis | 2da489c | 2012-09-19 18:06:29 -0700 | [diff] [blame] | 255 | <!-- BEGIN TRACE --> |
Jamie Gennis | 9279147 | 2012-03-05 17:33:58 -0800 | [diff] [blame] | 256 | <script> |
| 257 | var linuxPerfData = "\\ |
| 258 | """ |
| 259 | |
Jamie Gennis | 2da489c | 2012-09-19 18:06:29 -0700 | [diff] [blame] | 260 | html_suffix = """\\n"; |
Jamie Gennis | 9279147 | 2012-03-05 17:33:58 -0800 | [diff] [blame] | 261 | </script> |
Jamie Gennis | 2da489c | 2012-09-19 18:06:29 -0700 | [diff] [blame] | 262 | <!-- END TRACE --> |
Jamie Gennis | 9279147 | 2012-03-05 17:33:58 -0800 | [diff] [blame] | 263 | </body> |
| 264 | </html> |
| 265 | """ |
| 266 | |
Jeff Brown | 595ae1e | 2012-05-22 14:52:13 -0700 | [diff] [blame] | 267 | compiled_css_tag = """<style type="text/css">%s</style>""" |
| 268 | compiled_js_tag = """<script language="javascript">%s</script>""" |
| 269 | |
| 270 | linked_css_tag = """<link rel="stylesheet" href="%s"></link>""" |
| 271 | linked_js_tag = """<script language="javascript" src="%s"></script>""" |
| 272 | |
Jamie Gennis | 9279147 | 2012-03-05 17:33:58 -0800 | [diff] [blame] | 273 | if __name__ == '__main__': |
| 274 | main() |