Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 1 | #!/usr/bin/env python |
| 2 | |
| 3 | # Copyright (C) 2017 The Android Open Source Project |
| 4 | # |
| 5 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | # you may not use this file except in compliance with the License. |
| 7 | # You may obtain a copy of the License at |
| 8 | # |
| 9 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | # |
| 11 | # Unless required by applicable law or agreed to in writing, software |
| 12 | # distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | # See the License for the specific language governing permissions and |
| 15 | # limitations under the License. |
| 16 | |
| 17 | from __future__ import absolute_import |
| 18 | from __future__ import division |
| 19 | from __future__ import print_function |
| 20 | |
| 21 | import argparse |
| 22 | import atexit |
| 23 | import hashlib |
| 24 | import os |
| 25 | import signal |
| 26 | import subprocess |
| 27 | import sys |
| 28 | import tempfile |
| 29 | import time |
| 30 | import urllib |
| 31 | |
| 32 | TRACE_TO_TEXT_SHAS = { |
Florian Mayer | 854d22f | 2019-04-17 15:39:47 +0100 | [diff] [blame] | 33 | 'linux': 'a8171d85c5964ccafe457142dbb7df68ca8da543', |
| 34 | 'mac': '268c2fc096039566979d16c1a7a99eabef0d9682', |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 35 | } |
| 36 | TRACE_TO_TEXT_PATH = tempfile.gettempdir() |
| 37 | TRACE_TO_TEXT_BASE_URL = ( |
| 38 | 'https://storage.googleapis.com/perfetto/') |
| 39 | |
Florian Mayer | bd0a62a | 2019-04-10 11:09:21 +0100 | [diff] [blame] | 40 | NULL = open(os.devnull) |
| 41 | NOOUT = { |
| 42 | 'stdout': NULL, |
| 43 | 'stderr': NULL, |
| 44 | } |
| 45 | |
| 46 | |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 47 | def check_hash(file_name, sha_value): |
| 48 | with open(file_name, 'rb') as fd: |
| 49 | # TODO(fmayer): Chunking. |
| 50 | file_hash = hashlib.sha1(fd.read()).hexdigest() |
| 51 | return file_hash == sha_value |
| 52 | |
| 53 | |
| 54 | def load_trace_to_text(platform): |
| 55 | sha_value = TRACE_TO_TEXT_SHAS[platform] |
| 56 | file_name = 'trace_to_text-' + platform + '-' + sha_value |
| 57 | local_file = os.path.join(TRACE_TO_TEXT_PATH, file_name) |
| 58 | |
| 59 | if os.path.exists(local_file): |
| 60 | if not check_hash(local_file, sha_value): |
| 61 | os.remove(local_file) |
| 62 | else: |
| 63 | return local_file |
| 64 | |
| 65 | url = TRACE_TO_TEXT_BASE_URL + file_name |
| 66 | urllib.urlretrieve(url, local_file) |
| 67 | if not check_hash(local_file, sha_value): |
| 68 | os.remove(local_file) |
| 69 | raise ValueError("Invalid signature.") |
| 70 | os.chmod(local_file, 0o755) |
| 71 | return local_file |
| 72 | |
Florian Mayer | fe4361d | 2019-05-14 11:54:00 +0100 | [diff] [blame^] | 73 | PACKAGES_LIST_CFG='''data_sources {{ |
| 74 | config {{ |
| 75 | name: "android.packages_list" |
| 76 | }} |
| 77 | }} |
| 78 | ''' |
| 79 | |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 80 | |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 81 | CFG_IDENT = ' ' |
| 82 | CFG='''buffers {{ |
| 83 | size_kb: 32768 |
| 84 | }} |
| 85 | |
| 86 | data_sources {{ |
| 87 | config {{ |
| 88 | name: "android.heapprofd" |
| 89 | heapprofd_config {{ |
| 90 | |
Florian Mayer | 91b3c6d | 2019-04-10 13:44:37 -0700 | [diff] [blame] | 91 | shmem_size_bytes: {shmem_size} |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 92 | sampling_interval_bytes: {interval} |
| 93 | {target_cfg} |
Florian Mayer | a8312c7 | 2019-01-31 13:50:22 +0000 | [diff] [blame] | 94 | {continuous_dump_cfg} |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 95 | }} |
| 96 | }} |
| 97 | }} |
| 98 | |
| 99 | duration_ms: {duration} |
Florian Mayer | 2aab316 | 2019-05-03 16:02:30 +0100 | [diff] [blame] | 100 | write_into_file: true |
Florian Mayer | 8261046 | 2019-04-16 10:26:07 +0100 | [diff] [blame] | 101 | flush_timeout_ms: 30000 |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 102 | ''' |
| 103 | |
Florian Mayer | a8312c7 | 2019-01-31 13:50:22 +0000 | [diff] [blame] | 104 | CONTINUOUS_DUMP = """ |
| 105 | continuous_dump_config {{ |
| 106 | dump_phase_ms: 0 |
| 107 | dump_interval_ms: {dump_interval} |
| 108 | }} |
| 109 | """ |
| 110 | |
Florian Mayer | bb3b682 | 2019-03-08 17:08:59 +0000 | [diff] [blame] | 111 | PERFETTO_CMD=('CFG=\'{cfg}\'; echo ${{CFG}} | ' |
| 112 | 'perfetto --txt -c - -o ' |
| 113 | '/data/misc/perfetto-traces/profile-{user} -d') |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 114 | IS_INTERRUPTED = False |
| 115 | def sigint_handler(sig, frame): |
| 116 | global IS_INTERRUPTED |
| 117 | IS_INTERRUPTED = True |
| 118 | |
| 119 | |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 120 | def main(argv): |
| 121 | parser = argparse.ArgumentParser() |
| 122 | parser.add_argument("-i", "--interval", help="Sampling interval. " |
Florian Mayer | 607c1bc | 2019-02-01 11:04:58 +0000 | [diff] [blame] | 123 | "Default 4096 (4KiB)", type=int, default=4096) |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 124 | parser.add_argument("-d", "--duration", help="Duration of profile (ms). " |
Florian Mayer | 0eee91b | 2019-05-10 10:36:16 +0100 | [diff] [blame] | 125 | "Default 7 days.", type=int, default=604800000) |
| 126 | parser.add_argument("--no-start", help="Do not start heapprofd.", |
Florian Mayer | 33ceb8d | 2019-01-11 14:51:28 +0000 | [diff] [blame] | 127 | action='store_true') |
Florian Mayer | 0eee91b | 2019-05-10 10:36:16 +0100 | [diff] [blame] | 128 | parser.add_argument("-p", "--pid", help="Comma-separated list of PIDs to " |
| 129 | "profile.", metavar="PIDS") |
| 130 | parser.add_argument("-n", "--name", help="Comma-separated list of process " |
| 131 | "names to profile.", metavar="NAMES") |
Florian Mayer | a8312c7 | 2019-01-31 13:50:22 +0000 | [diff] [blame] | 132 | parser.add_argument("-c", "--continuous-dump", |
| 133 | help="Dump interval in ms. 0 to disable continuous dump.", |
| 134 | type=int, default=0) |
Florian Mayer | 6ae9526 | 2018-12-06 16:10:29 +0000 | [diff] [blame] | 135 | parser.add_argument("--disable-selinux", action="store_true", |
| 136 | help="Disable SELinux enforcement for duration of " |
Florian Mayer | 0eee91b | 2019-05-10 10:36:16 +0100 | [diff] [blame] | 137 | "profile.") |
Florian Mayer | fe4361d | 2019-05-14 11:54:00 +0100 | [diff] [blame^] | 138 | parser.add_argument("--no-versions", action="store_true", |
| 139 | help="Do not get version information about APKs.") |
Florian Mayer | 91b3c6d | 2019-04-10 13:44:37 -0700 | [diff] [blame] | 140 | parser.add_argument("--shmem-size", help="Size of buffer between client and " |
| 141 | "heapprofd. Default 8MiB. Needs to be a power of two " |
| 142 | "multiple of 4096, at least 8192.", type=int, |
| 143 | default=8 * 1048576) |
Florian Mayer | d6bdb6f | 2019-05-03 17:53:58 +0100 | [diff] [blame] | 144 | parser.add_argument("--block-client", help="When buffer is full, block the " |
Florian Mayer | 1a17b68 | 2019-05-09 12:02:45 +0100 | [diff] [blame] | 145 | "client to wait for buffer space. Use with caution as " |
Florian Mayer | 0eee91b | 2019-05-10 10:36:16 +0100 | [diff] [blame] | 146 | "this can significantly slow down the client.", |
Florian Mayer | d6bdb6f | 2019-05-03 17:53:58 +0100 | [diff] [blame] | 147 | action="store_true") |
Florian Mayer | 2b8a3b2 | 2019-05-02 18:35:38 +0100 | [diff] [blame] | 148 | parser.add_argument("--simpleperf", action="store_true", |
| 149 | help="Get simpleperf profile of heapprofd. This is " |
| 150 | "only for heapprofd development.") |
Florian Mayer | 0eee91b | 2019-05-10 10:36:16 +0100 | [diff] [blame] | 151 | parser.add_argument("--trace-to-text-binary", |
| 152 | help="Path to local trace to text. For debugging.") |
Florian Mayer | fe4361d | 2019-05-14 11:54:00 +0100 | [diff] [blame^] | 153 | parser.add_argument("--print-config", action="store_true", |
| 154 | help="Print config instead of running. For debugging.") |
Florian Mayer | 0eee91b | 2019-05-10 10:36:16 +0100 | [diff] [blame] | 155 | |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 156 | args = parser.parse_args() |
| 157 | |
| 158 | fail = False |
Florian Mayer | a774cb7 | 2019-04-29 14:20:43 +0100 | [diff] [blame] | 159 | if args.pid is None and args.name is None: |
| 160 | print("FATAL: Neither PID nor NAME given.", file=sys.stderr) |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 161 | fail = True |
| 162 | if args.duration is None: |
| 163 | print("FATAL: No duration given.", file=sys.stderr) |
| 164 | fail = True |
| 165 | if args.interval is None: |
| 166 | print("FATAL: No interval given.", file=sys.stderr) |
| 167 | fail = True |
Florian Mayer | 91b3c6d | 2019-04-10 13:44:37 -0700 | [diff] [blame] | 168 | if args.shmem_size % 4096: |
| 169 | print("FATAL: shmem-size is not a multiple of 4096.", file=sys.stderr) |
| 170 | fail = True |
| 171 | if args.shmem_size < 8192: |
| 172 | print("FATAL: shmem-size is less than 8192.", file=sys.stderr) |
| 173 | fail = True |
| 174 | if args.shmem_size & (args.shmem_size - 1): |
| 175 | print("FATAL: shmem-size is not a power of two.", file=sys.stderr) |
| 176 | fail = True |
Florian Mayer | 0eee91b | 2019-05-10 10:36:16 +0100 | [diff] [blame] | 177 | |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 178 | target_cfg = "" |
Florian Mayer | d6bdb6f | 2019-05-03 17:53:58 +0100 | [diff] [blame] | 179 | if args.block_client: |
| 180 | target_cfg += "block_client: true\n" |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 181 | if args.pid: |
Florian Mayer | 0eee91b | 2019-05-10 10:36:16 +0100 | [diff] [blame] | 182 | for pid in args.pid.split(','): |
| 183 | try: |
| 184 | pid = int(pid) |
| 185 | except ValueError: |
| 186 | print("FATAL: invalid PID %s" % pid, file=sys.stderr) |
| 187 | fail = True |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 188 | target_cfg += '{}pid: {}\n'.format(CFG_IDENT, pid) |
| 189 | if args.name: |
Florian Mayer | 0eee91b | 2019-05-10 10:36:16 +0100 | [diff] [blame] | 190 | for name in args.name.split(','): |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 191 | target_cfg += '{}process_cmdline: "{}"\n'.format(CFG_IDENT, name) |
| 192 | |
Florian Mayer | 0eee91b | 2019-05-10 10:36:16 +0100 | [diff] [blame] | 193 | if fail: |
| 194 | parser.print_help() |
| 195 | return 1 |
| 196 | |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 197 | trace_to_text_binary = args.trace_to_text_binary |
| 198 | if trace_to_text_binary is None: |
| 199 | platform = None |
| 200 | if sys.platform.startswith('linux'): |
| 201 | platform = 'linux' |
| 202 | elif sys.platform.startswith('darwin'): |
| 203 | platform = 'mac' |
| 204 | else: |
| 205 | print("Invalid platform: {}".format(sys.platform), file=sys.stderr) |
Florian Mayer | b627963 | 2018-11-29 13:31:49 +0000 | [diff] [blame] | 206 | return 1 |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 207 | |
| 208 | trace_to_text_binary = load_trace_to_text(platform) |
| 209 | |
Florian Mayer | a8312c7 | 2019-01-31 13:50:22 +0000 | [diff] [blame] | 210 | continuous_dump_cfg = "" |
| 211 | if args.continuous_dump: |
| 212 | continuous_dump_cfg = CONTINUOUS_DUMP.format( |
| 213 | dump_interval=args.continuous_dump) |
Florian Mayer | a774cb7 | 2019-04-29 14:20:43 +0100 | [diff] [blame] | 214 | cfg = CFG.format(interval=args.interval, |
Florian Mayer | a8312c7 | 2019-01-31 13:50:22 +0000 | [diff] [blame] | 215 | duration=args.duration, target_cfg=target_cfg, |
Florian Mayer | 91b3c6d | 2019-04-10 13:44:37 -0700 | [diff] [blame] | 216 | continuous_dump_cfg=continuous_dump_cfg, |
| 217 | shmem_size=args.shmem_size) |
Florian Mayer | fe4361d | 2019-05-14 11:54:00 +0100 | [diff] [blame^] | 218 | if not args.no_versions: |
| 219 | cfg += PACKAGES_LIST_CFG |
| 220 | |
| 221 | if args.print_config: |
| 222 | print(cfg) |
| 223 | return 0 |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 224 | |
Florian Mayer | 6ae9526 | 2018-12-06 16:10:29 +0000 | [diff] [blame] | 225 | if args.disable_selinux: |
| 226 | enforcing = subprocess.check_output(['adb', 'shell', 'getenforce']) |
| 227 | atexit.register(subprocess.check_call, |
| 228 | ['adb', 'shell', 'su root setenforce %s' % enforcing]) |
| 229 | subprocess.check_call(['adb', 'shell', 'su root setenforce 0']) |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 230 | |
Florian Mayer | 33ceb8d | 2019-01-11 14:51:28 +0000 | [diff] [blame] | 231 | if not args.no_start: |
Florian Mayer | 75266d5 | 2019-02-01 18:09:43 +0000 | [diff] [blame] | 232 | heapprofd_prop = subprocess.check_output( |
| 233 | ['adb', 'shell', 'getprop persist.heapprofd.enable']) |
| 234 | if heapprofd_prop.strip() != '1': |
| 235 | subprocess.check_call( |
| 236 | ['adb', 'shell', 'setprop persist.heapprofd.enable 1']) |
| 237 | atexit.register(subprocess.check_call, |
| 238 | ['adb', 'shell', 'setprop persist.heapprofd.enable 0']) |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 239 | |
Florian Mayer | bb3b682 | 2019-03-08 17:08:59 +0000 | [diff] [blame] | 240 | user = subprocess.check_output(['adb', 'shell', 'whoami']).strip() |
Florian Mayer | 2b8a3b2 | 2019-05-02 18:35:38 +0100 | [diff] [blame] | 241 | |
| 242 | if args.simpleperf: |
| 243 | subprocess.check_call( |
| 244 | ['adb', 'shell', |
| 245 | 'mkdir -p /data/local/tmp/heapprofd_profile && ' |
| 246 | 'cd /data/local/tmp/heapprofd_profile &&' |
| 247 | '(nohup simpleperf record -g -p $(pgrep heapprofd) 2>&1 &) ' |
| 248 | '> /dev/null']) |
| 249 | |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 250 | perfetto_pid = subprocess.check_output( |
Florian Mayer | bb3b682 | 2019-03-08 17:08:59 +0000 | [diff] [blame] | 251 | ['adb', 'exec-out', PERFETTO_CMD.format(cfg=cfg, user=user)]).strip() |
Florian Mayer | 3564742 | 2019-03-07 16:28:10 +0000 | [diff] [blame] | 252 | try: |
| 253 | int(perfetto_pid.strip()) |
| 254 | except ValueError: |
| 255 | print("Failed to invoke perfetto: {}".format(perfetto_pid), |
| 256 | file=sys.stderr) |
| 257 | return 1 |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 258 | |
| 259 | old_handler = signal.signal(signal.SIGINT, sigint_handler) |
| 260 | print("Profiling active. Press Ctrl+C to terminate.") |
Florian Mayer | bd0a62a | 2019-04-10 11:09:21 +0100 | [diff] [blame] | 261 | print("You may disconnect your device.") |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 262 | exists = True |
Florian Mayer | bd0a62a | 2019-04-10 11:09:21 +0100 | [diff] [blame] | 263 | device_connected = True |
| 264 | while not device_connected or (exists and not IS_INTERRUPTED): |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 265 | exists = subprocess.call( |
Florian Mayer | bd0a62a | 2019-04-10 11:09:21 +0100 | [diff] [blame] | 266 | ['adb', 'shell', '[ -d /proc/{} ]'.format(perfetto_pid)], |
| 267 | **NOOUT) == 0 |
| 268 | device_connected = subprocess.call(['adb', 'shell', 'true'], **NOOUT) == 0 |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 269 | time.sleep(1) |
| 270 | signal.signal(signal.SIGINT, old_handler) |
| 271 | if IS_INTERRUPTED: |
| 272 | # Not check_call because it could have existed in the meantime. |
Florian Mayer | 85969b9 | 2019-01-23 17:23:16 +0000 | [diff] [blame] | 273 | subprocess.call(['adb', 'shell', 'kill', '-INT', perfetto_pid]) |
Florian Mayer | 2b8a3b2 | 2019-05-02 18:35:38 +0100 | [diff] [blame] | 274 | if args.simpleperf: |
| 275 | subprocess.check_call(['adb', 'shell', 'killall', '-INT', 'simpleperf']) |
| 276 | print("Waiting for simpleperf to exit.") |
| 277 | while subprocess.call( |
| 278 | ['adb', 'shell', '[ -f /proc/$(pgrep simpleperf)/exe ]'], |
| 279 | **NOOUT) == 0: |
| 280 | time.sleep(1) |
| 281 | subprocess.check_call(['adb', 'pull', '/data/local/tmp/heapprofd_profile', |
| 282 | '/tmp']) |
| 283 | print("Pulled simpleperf profile to /tmp/heapprofd_profile") |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 284 | |
Florian Mayer | ddbe31e | 2018-11-30 14:49:30 +0000 | [diff] [blame] | 285 | # Wait for perfetto cmd to return. |
| 286 | while exists: |
| 287 | exists = subprocess.call( |
| 288 | ['adb', 'shell', '[ -d /proc/{} ]'.format(perfetto_pid)]) == 0 |
| 289 | time.sleep(1) |
| 290 | |
Florian Mayer | bb3b682 | 2019-03-08 17:08:59 +0000 | [diff] [blame] | 291 | subprocess.check_call(['adb', 'pull', |
| 292 | '/data/misc/perfetto-traces/profile-{}'.format(user), |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 293 | '/tmp/profile'], stdout=NULL) |
| 294 | trace_to_text_output = subprocess.check_output( |
Florian Mayer | 6fc484e | 2019-04-10 16:07:54 +0100 | [diff] [blame] | 295 | [trace_to_text_binary, 'profile', '/tmp/profile']) |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 296 | profile_path = None |
| 297 | for word in trace_to_text_output.split(): |
| 298 | if 'heap_profile-' in word: |
| 299 | profile_path = word |
| 300 | if profile_path is None: |
| 301 | print("Could not find trace_to_text output path.", file=sys.stderr) |
| 302 | return 1 |
| 303 | |
| 304 | profile_files = os.listdir(profile_path) |
| 305 | if not profile_files: |
| 306 | print("No profiles generated", file=sys.stderr) |
| 307 | return 1 |
| 308 | |
| 309 | subprocess.check_call(['gzip'] + [os.path.join(profile_path, x) for x in |
| 310 | os.listdir(profile_path)]) |
Florian Mayer | 82f43d1 | 2019-01-17 14:37:45 +0000 | [diff] [blame] | 311 | |
| 312 | symlink_path = os.path.join(os.path.dirname(profile_path), |
| 313 | "heap_profile-latest") |
Florian Mayer | 91967ee | 2019-05-10 16:43:50 +0100 | [diff] [blame] | 314 | if os.path.lexists(symlink_path): |
Florian Mayer | 3130551 | 2019-01-21 17:37:02 +0000 | [diff] [blame] | 315 | os.unlink(symlink_path) |
Florian Mayer | 82f43d1 | 2019-01-17 14:37:45 +0000 | [diff] [blame] | 316 | os.symlink(profile_path, symlink_path) |
| 317 | |
| 318 | print("Wrote profiles to {} (symlink {})".format(profile_path, symlink_path)) |
Florian Mayer | 801349e | 2018-11-29 10:15:25 +0000 | [diff] [blame] | 319 | print("These can be viewed using pprof. Googlers: head to pprof/ and " |
| 320 | "upload them.") |
| 321 | |
| 322 | |
| 323 | if __name__ == '__main__': |
| 324 | sys.exit(main(sys.argv)) |