tools/heap_profile

#!/usr/bin/env python3
# Copyright (C) 2017 The Android Open Source Project
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
# DO NOT EDIT. Auto-generated by tools/gen_amalgamated_python_tools
# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

from __future__ import absolute_import
from __future__ import division
from __future__ import print_function

import argparse
import atexit
import os
import shutil
import signal
import subprocess
import sys
import tempfile
import time
import uuid

# ----- Amalgamator: begin of python/perfetto/prebuilts/manifests/heapprofd_glibc_preload.py
# This file has been generated by: tools/release/roll-prebuilts
# Placeholder - real values will be filled by roll-prebuilts after the first
# LUCI build that includes this artifact.
HEAPPROFD_GLIBC_PRELOAD_MANIFEST = [{
    'arch': 'linux-amd64',
    'file_name': 'libheapprofd_glibc_preload.so',
    'file_size': 0,
    'url': '',
    'sha256': '',
    'platform': 'linux',
    'machine': ['x86_64']
}, {
    'arch': 'linux-arm',
    'file_name': 'libheapprofd_glibc_preload.so',
    'file_size': 0,
    'url': '',
    'sha256': '',
    'platform': 'linux',
    'machine': ['armv6l', 'armv7l', 'armv8l']
}, {
    'arch': 'linux-arm64',
    'file_name': 'libheapprofd_glibc_preload.so',
    'file_size': 0,
    'url': '',
    'sha256': '',
    'platform': 'linux',
    'machine': ['aarch64']
}]

# ----- Amalgamator: end of python/perfetto/prebuilts/manifests/heapprofd_glibc_preload.py

# ----- Amalgamator: begin of python/perfetto/prebuilts/manifests/tracebox.py
# This file has been generated by: tools/release/roll-prebuilts v54.0
TRACEBOX_MANIFEST = [{
    'arch':
        'mac-amd64',
    'file_name':
        'tracebox',
    'file_size':
        1944464,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v54.0/mac-amd64/tracebox',
    'sha256':
        'a40c44760413a8aad71241df60fbeeee0eba5acc8a7c0f82a9e0aadfcedddd5c',
    'platform':
        'darwin',
    'machine': ['x86_64']
}, {
    'arch':
        'mac-arm64',
    'file_name':
        'tracebox',
    'file_size':
        1808520,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v54.0/mac-arm64/tracebox',
    'sha256':
        '1f4ea7516dde2373eb554eaaff85a09a6e193a25ada1846be7a981d53ccc242a',
    'platform':
        'darwin',
    'machine': ['arm64']
}, {
    'arch':
        'linux-amd64',
    'file_name':
        'tracebox',
    'file_size':
        2749472,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v54.0/linux-amd64/tracebox',
    'sha256':
        '926ec28dc38ef1b1460afd57402023a570d5767fe47c78b8e48367e14f0fb89b',
    'platform':
        'linux',
    'machine': ['x86_64']
}, {
    'arch':
        'linux-arm',
    'file_name':
        'tracebox',
    'file_size':
        1688924,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v54.0/linux-arm/tracebox',
    'sha256':
        '261d7c2fcda470c5e9eba4be9be93fef9f21dee9e7131a4b619f35cb19c910f2',
    'platform':
        'linux',
    'machine': ['armv6l', 'armv7l', 'armv8l']
}, {
    'arch':
        'linux-arm64',
    'file_name':
        'tracebox',
    'file_size':
        2621376,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v54.0/linux-arm64/tracebox',
    'sha256':
        'c1dd57aa4632e8704c6c49f077e4e9d76163cabc9d406c6d49e0dc3a0ec35c4d',
    'platform':
        'linux',
    'machine': ['aarch64']
}, {
    'arch':
        'android-arm',
    'file_name':
        'tracebox',
    'file_size':
        1568992,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v54.0/android-arm/tracebox',
    'sha256':
        '41827319c6d258c264042d10b7f2584135fc65cc31fe60bc2413a45a0e8d6e42'
}, {
    'arch':
        'android-arm64',
    'file_name':
        'tracebox',
    'file_size':
        2467952,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v54.0/android-arm64/tracebox',
    'sha256':
        'a7c6a7df683ba098aef3d747ead69d25e937aaf3241d47d2d87f1d2826588768'
}, {
    'arch':
        'android-x86',
    'file_name':
        'tracebox',
    'file_size':
        2721224,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v54.0/android-x86/tracebox',
    'sha256':
        '4746ab7e7df129b93e504c5a40b89c3fdd1a66bfb389cf06979a59ffb4458d08'
}, {
    'arch':
        'android-x64',
    'file_name':
        'tracebox',
    'file_size':
        2516984,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v54.0/android-x64/tracebox',
    'sha256':
        '193f686e290a6f4d53c7a06cea487f3c9ac5f8990d036a79713d6a088482ead8'
}]

# ----- Amalgamator: end of python/perfetto/prebuilts/manifests/tracebox.py

# ----- Amalgamator: begin of python/perfetto/prebuilts/manifests/traceconv.py
# This file has been generated by: tools/release/roll-prebuilts v54.0
TRACECONV_MANIFEST = [{
    'arch':
        'mac-amd64',
    'file_name':
        'traceconv',
    'file_size':
        11174856,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v54.0/mac-amd64/traceconv',
    'sha256':
        '554ecfa7fff1ed35ed0d046e244d42d27b5e9f0067b08db68e5cb7f9eace879a',
    'platform':
        'darwin',
    'machine': ['x86_64']
}, {
    'arch':
        'mac-arm64',
    'file_name':
        'traceconv',
    'file_size':
        10357864,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v54.0/mac-arm64/traceconv',
    'sha256':
        '3976ef9871626ce28ceb32a36c657505a21f63c02837bb0ea51081412d79f4d7',
    'platform':
        'darwin',
    'machine': ['arm64']
}, {
    'arch':
        'linux-amd64',
    'file_name':
        'traceconv',
    'file_size':
        11352048,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v54.0/linux-amd64/traceconv',
    'sha256':
        '419bc40b76f23a5705def8624d5fdf31fd42ba1e3816fd056bf93f431cc156d1',
    'platform':
        'linux',
    'machine': ['x86_64']
}, {
    'arch':
        'linux-arm',
    'file_name':
        'traceconv',
    'file_size':
        8655236,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v54.0/linux-arm/traceconv',
    'sha256':
        '086721b87c8d3d865fb063f3f6e65127457884eb8e5da9f78eae2313a7383772',
    'platform':
        'linux',
    'machine': ['armv6l', 'armv7l', 'armv8l']
}, {
    'arch':
        'linux-arm64',
    'file_name':
        'traceconv',
    'file_size':
        10772720,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v54.0/linux-arm64/traceconv',
    'sha256':
        '1faf695042ccc907d66d663928a2c62d8f5ece16623f97a3a3260cda67e8e15a',
    'platform':
        'linux',
    'machine': ['aarch64']
}, {
    'arch':
        'android-arm',
    'file_name':
        'traceconv',
    'file_size':
        8664936,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v54.0/android-arm/traceconv',
    'sha256':
        'ccd20eb089b956e2229062680b991ec6f526332353ada57ca034dae2667c481f'
}, {
    'arch':
        'android-arm64',
    'file_name':
        'traceconv',
    'file_size':
        10696848,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v54.0/android-arm64/traceconv',
    'sha256':
        'ba2ecc2978fd28e1a6e629e13a54d365c7f9cb0828dbf9aea27e585f1b79a030'
}, {
    'arch':
        'android-x86',
    'file_name':
        'traceconv',
    'file_size':
        11869456,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v54.0/android-x86/traceconv',
    'sha256':
        '5c659c672126e844ec8465bcb224ebeddf702f411756f5bbc1168d61d3312ce7'
}, {
    'arch':
        'android-x64',
    'file_name':
        'traceconv',
    'file_size':
        11188840,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v54.0/android-x64/traceconv',
    'sha256':
        '8d253f5a24e10a1f1022317670bb82cc1b0c6a5545d5ca3df41762d93152d01e'
}, {
    'arch':
        'windows-amd64',
    'file_name':
        'traceconv.exe',
    'file_size':
        11050496,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v54.0/windows-amd64/traceconv.exe',
    'sha256':
        '795e60d3649c9c243be52e9e310327c3f88b441e1514b666fa690aaace770cdd',
    'platform':
        'win32',
    'machine': ['amd64']
}]

# ----- Amalgamator: end of python/perfetto/prebuilts/manifests/traceconv.py

# ----- Amalgamator: begin of python/perfetto/prebuilts/perfetto_prebuilts.py
# Copyright (C) 2021 The Android Open Source Project
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
Functions to fetch pre-pinned Perfetto prebuilts.

This function is used in different places:
- Into the //tools/{trace_processor, traceconv} scripts, which are just plain
  wrappers around executables.
- Into the //tools/{heap_profiler, record_android_trace} scripts, which contain
  some other hand-written python code.

The manifest argument looks as follows:
TRACECONV_MANIFEST = [
  {
    'arch': 'mac-amd64',
    'file_name': 'traceconv',
    'file_size': 7087080,
    'url': https://commondatastorage.googleapis.com/.../trace_to_text',
    'sha256': 7d957c005b0dc130f5bd855d6cec27e060d38841b320d04840afc569f9087490',
    'platform': 'darwin',
    'machine': 'x86_64'
  },
  ...
]

The intended usage is:

  from perfetto.prebuilts.manifests.traceconv import TRACECONV_MANIFEST
  bin_path = get_perfetto_prebuilt(TRACECONV_MANIFEST)
  subprocess.call(bin_path, ...)
"""

import hashlib
import os
import platform
import random
import subprocess
import sys


def download_or_get_cached(file_name, url, sha256):
  """ Downloads a prebuilt or returns a cached version

  The first time this is invoked, it downloads the |url| and caches it into
  ~/.local/share/perfetto/prebuilts/$tool_name. On subsequent invocations it
  just runs the cached version.
  """
  dir = os.path.join(
      os.path.expanduser('~'), '.local', 'share', 'perfetto', 'prebuilts')
  os.makedirs(dir, exist_ok=True)
  bin_path = os.path.join(dir, file_name)
  sha256_path = os.path.join(dir, file_name + '.sha256')
  needs_download = True

  # Avoid recomputing the SHA-256 on each invocation. The SHA-256 of the last
  # download is cached into file_name.sha256, just check if that matches.
  if os.path.exists(bin_path) and os.path.exists(sha256_path):
    with open(sha256_path, 'rb') as f:
      digest = f.read().decode()
      if digest == sha256:
        needs_download = False

  if needs_download:  # The file doesn't exist or the SHA256 doesn't match.
    # Use a unique random file to guard against concurrent executions.
    # See https://github.com/google/perfetto/issues/786 .
    tmp_path = '%s.%d.tmp' % (bin_path, random.randint(0, 100000))
    print('Downloading ' + url)
    subprocess.check_call(['curl', '-f', '-L', '-#', '-o', tmp_path, url])
    with open(tmp_path, 'rb') as fd:
      actual_sha256 = hashlib.sha256(fd.read()).hexdigest()
    if actual_sha256 != sha256:
      raise Exception('Checksum mismatch for %s (actual: %s, expected: %s)' %
                      (url, actual_sha256, sha256))
    os.chmod(tmp_path, 0o755)
    os.replace(tmp_path, bin_path)
    with open(tmp_path, 'w') as f:
      f.write(sha256)
    os.replace(tmp_path, sha256_path)
  return bin_path


def get_perfetto_prebuilt(manifest, soft_fail=False, arch=None):
  """ Downloads the prebuilt, if necessary, and returns its path on disk. """
  plat = sys.platform.lower()
  machine = platform.machine().lower()
  manifest_entry = None
  for entry in manifest:
    # If the caller overrides the arch, just match that (for Android prebuilts).
    if arch:
      if entry.get('arch') == arch:
        manifest_entry = entry
        break
      continue
    # Otherwise guess the local machine arch.
    if entry.get('platform') == plat and machine in entry.get('machine', []):
      manifest_entry = entry
      break
  if manifest_entry is None:
    if soft_fail:
      return None
    raise Exception(
        ('No prebuilts available for %s-%s\n' % (plat, machine)) +
        'See https://perfetto.dev/docs/contributing/build-instructions')

  # Placeholder entries (e.g. before a release has been rolled) have an empty
  # URL. Treat them the same as a missing entry when soft_fail is set.
  if not manifest_entry.get('url'):
    if soft_fail:
      return None
    raise Exception('No prebuilt URL available for %s on %s-%s. '
                    'The prebuilt may not have been rolled yet.' %
                    (manifest_entry.get('file_name', '?'), plat, machine))

  return download_or_get_cached(
      file_name=manifest_entry['file_name'],
      url=manifest_entry['url'],
      sha256=manifest_entry['sha256'])


def run_perfetto_prebuilt(manifest):
  bin_path = get_perfetto_prebuilt(manifest)
  if sys.platform.lower() == 'win32':
    sys.exit(subprocess.check_call([bin_path, *sys.argv[1:]]))
  os.execv(bin_path, [bin_path] + sys.argv[1:])


# ----- Amalgamator: end of python/perfetto/prebuilts/perfetto_prebuilts.py

NULL = open(os.devnull)

NOOUT = {
    'stdout': NULL,
    'stderr': NULL,
}

UUID = str(uuid.uuid4())[-6:]

PACKAGES_LIST_CFG = '''data_sources {
  config {
    name: "android.packages_list"
  }
}
'''

CFG_INDENT = '      '
CFG = '''buffers {{
  size_kb: 63488
}}

data_sources {{
  config {{
    name: "android.heapprofd"
    heapprofd_config {{
      shmem_size_bytes: {shmem_size}
      sampling_interval_bytes: {interval}
{target_cfg}
    }}
  }}
}}

duration_ms: {duration}
write_into_file: true
flush_timeout_ms: 30000
flush_period_ms: 604800000
'''

# flush_period_ms of 1 week to suppress trace_processor_shell warning.

CONTINUOUS_DUMP = """
      continuous_dump_config {{
        dump_phase_ms: 0
        dump_interval_ms: {dump_interval}
      }}
"""

PROFILE_LOCAL_PATH = os.path.join(tempfile.gettempdir(), UUID)

IS_INTERRUPTED = False


def sigint_handler(sig, frame):
  global IS_INTERRUPTED
  IS_INTERRUPTED = True


def print_no_profile_error():
  print("No profiles generated", file=sys.stderr)
  print(
      "If this is unexpected, check "
      "https://perfetto.dev/docs/data-sources/native-heap-profiler#troubleshooting.",
      file=sys.stderr)


def known_issues_url(number):
  return ('https://perfetto.dev/docs/data-sources/native-heap-profiler'
          '#known-issues-android{}'.format(number))


KNOWN_ISSUES = {
    '10': known_issues_url(10),
    'Q': known_issues_url(10),
    '11': known_issues_url(11),
    'R': known_issues_url(11),
}


def maybe_known_issues():
  release_or_codename = subprocess.check_output(
      ['adb', 'shell', 'getprop',
       'ro.build.version.release_or_codename']).decode('utf-8').strip()
  return KNOWN_ISSUES.get(release_or_codename, None)


SDK = {
    'R': 30,
}


def release_or_newer(release):
  sdk = int(
      subprocess.check_output(
          ['adb', 'shell', 'getprop',
           'ro.system.build.version.sdk']).decode('utf-8').strip())
  if sdk >= SDK[release]:
    return True
  codename = subprocess.check_output(
      ['adb', 'shell', 'getprop',
       'ro.build.version.codename']).decode('utf-8').strip()
  return codename == release


ORDER = ['-n', '-p', '-i', '-o']


def arg_order(action):
  result = len(ORDER)
  for opt in action.option_strings:
    if opt in ORDER:
      result = min(ORDER.index(opt), result)
  return result, action.option_strings[0].strip('-')


def process_trace(trace_file, profile_target, traceconv_binary, args,
                  android_mode):
  """Convert a raw trace to pprof via traceconv. Returns an exit code."""
  if traceconv_binary is None:
    print('Wrote profile to {}'.format(trace_file))
    print(
        'This file can be opened using the Perfetto UI, https://ui.perfetto.dev'
    )
    return 0

  concat_files = [trace_file]

  binary_path = os.getenv('PERFETTO_BINARY_PATH')
  if android_mode and not args.no_android_tree_symbolization:
    product_out = os.getenv('ANDROID_PRODUCT_OUT')
    product_out_symbols = product_out + '/symbols' if product_out else None
    if binary_path is None:
      binary_path = product_out_symbols
    elif product_out_symbols is not None:
      binary_path += os.pathsep + product_out_symbols

  if binary_path is not None:
    symbols_path = os.path.join(profile_target, 'symbols')
    with open(symbols_path, 'w') as fd:
      ret = subprocess.call([traceconv_binary, 'symbolize', trace_file],
                            env=dict(
                                os.environ, PERFETTO_BINARY_PATH=binary_path),
                            stdout=fd)
    if ret == 0:
      concat_files.append(symbols_path)
    else:
      print('Failed to symbolize. Continuing without symbols.', file=sys.stderr)

  if android_mode:
    proguard_map = os.getenv('PERFETTO_PROGUARD_MAP')
    if proguard_map is not None:
      deobf_path = os.path.join(profile_target, 'deobfuscation-packets')
      with open(deobf_path, 'w') as fd:
        ret = subprocess.call([traceconv_binary, 'deobfuscate', trace_file],
                              env=dict(
                                  os.environ,
                                  PERFETTO_PROGUARD_MAP=proguard_map),
                              stdout=fd)
      if ret == 0:
        concat_files.append(deobf_path)
      else:
        print(
            'Failed to deobfuscate. Continuing without deobfuscated.',
            file=sys.stderr)

  if len(concat_files) > 1:
    symbolized_path = os.path.join(profile_target, 'symbolized-trace')
    with open(symbolized_path, 'wb') as out:
      for fn in concat_files:
        with open(fn, 'rb') as inp:
          while True:
            buf = inp.read(4096)
            if not buf:
              break
            out.write(buf)
    trace_file = symbolized_path

  conversion_args = [traceconv_binary, 'profile'] + (
      ['--no-annotations'] if args.no_annotations else []) + [trace_file]
  traceconv_output = subprocess.check_output(
      conversion_args, stderr=subprocess.STDOUT)
  profile_path = None
  for word in traceconv_output.decode('utf-8').split():
    if 'heap_profile-' in word:
      profile_path = word
  if profile_path is None:
    print_no_profile_error()
    return 1

  profile_files = os.listdir(profile_path)
  if not profile_files:
    print_no_profile_error()
    return 1

  for profile_file in profile_files:
    shutil.copy(os.path.join(profile_path, profile_file), profile_target)

  symlink_path = None
  if not sys.platform.startswith('win'):
    subprocess.check_call(
        ['gzip'] + [os.path.join(profile_target, x) for x in profile_files])
    if args.output is None:
      symlink_path = os.path.join(
          os.path.dirname(profile_target), 'heap_profile-latest')
      if os.path.lexists(symlink_path):
        os.unlink(symlink_path)
      os.symlink(profile_target, symlink_path)

  if symlink_path is not None:
    print('Wrote profiles to {} (symlink {})'.format(profile_target,
                                                     symlink_path))
  else:
    print('Wrote profiles to {}'.format(profile_target))

  print('The raw-trace file can be viewed using https://ui.perfetto.dev.')
  print('The heap_dump.* files can be viewed using pprof/ (Googlers only) ' +
        'or https://www.speedscope.app/.')
  print('The two above are equivalent. The raw-trace contains the union of ' +
        'all the heap dumps.')
  return 0


def linux_main(args, cfg, cmd, traceconv_binary):
  """Run a local heap profile session on Linux using LD_PRELOAD."""
  tracebox_binary = args.tracebox_binary
  if tracebox_binary is None:
    tracebox_binary = get_perfetto_prebuilt(TRACEBOX_MANIFEST)

  preload_library = args.preload_library
  if preload_library is None:
    preload_library = get_perfetto_prebuilt(
        HEAPPROFD_GLIBC_PRELOAD_MANIFEST, soft_fail=True)
    if preload_library is None:
      print(
          'ERROR: libheapprofd_glibc_preload.so prebuilt is not yet available '
          'for this platform.',
          file=sys.stderr)
      print(
          'Build it from a Perfetto checkout and pass the path explicitly:',
          file=sys.stderr)
      print(
          '  tools/ninja -C <out_dir> heapprofd_glibc_preload', file=sys.stderr)
      print(
          '  heap_profile host --preload-library'
          ' <out_dir>/libheapprofd_glibc_preload.so ...',
          file=sys.stderr)
      return 1

  profile_target = PROFILE_LOCAL_PATH
  if args.output is not None:
    profile_target = args.output
  else:
    os.mkdir(profile_target)

  if not os.path.isdir(profile_target):
    print(
        'Output directory {} not found'.format(profile_target), file=sys.stderr)
    return 1

  if os.listdir(profile_target):
    print(
        'Output directory {} not empty'.format(profile_target), file=sys.stderr)
    return 1

  trace_output = os.path.join(profile_target, 'raw-trace')

  # Start the perfetto session. --system-sockets starts a bundled traced
  # daemon automatically on Linux. --notify-fd lets us wait until the session
  # is fully active before launching the profiled binary.
  notify_r, notify_w = os.pipe()
  perfetto_proc = subprocess.Popen([
      tracebox_binary, '--system-sockets', '--txt', '-c', '-', '-o',
      trace_output, '--notify-fd',
      str(notify_w)
  ],
                                   stdin=subprocess.PIPE,
                                   stdout=subprocess.DEVNULL,
                                   stderr=subprocess.DEVNULL,
                                   pass_fds=(notify_w,))
  os.close(notify_w)
  perfetto_proc.stdin.write(cfg.encode())
  perfetto_proc.stdin.close()

  # Block until the session is active before launching the profiled binary.
  os.read(notify_r, 1)
  os.close(notify_r)

  cmd_env = dict(
      os.environ,
      LD_PRELOAD=preload_library,
      PERFETTO_HEAPPROFD_BLOCKING_INIT='1')
  proc = subprocess.Popen(cmd, env=cmd_env)
  old_handler = signal.signal(signal.SIGINT, sigint_handler)
  proc.wait()
  signal.signal(signal.SIGINT, old_handler)
  perfetto_proc.send_signal(signal.SIGINT)

  print('Waiting for profiler shutdown...')
  perfetto_proc.wait()

  return process_trace(
      trace_output, profile_target, traceconv_binary, args, android_mode=False)


def print_options(parser):
  for action in sorted(parser._actions, key=arg_order):
    if action.help is argparse.SUPPRESS:
      continue
    opts = ', '.join('`' + x + '`' for x in action.option_strings)
    metavar = '' if action.metavar is None else ' _' + action.metavar + '_'
    print('{}{}'.format(opts, metavar))
    print(':    {}'.format(action.help))
    print()


def main(argv):
  # Flags shared by all subcommands.
  common = argparse.ArgumentParser(add_help=False)
  common.add_argument(
      "-i",
      "--interval",
      help="Sampling interval. "
      "Default 4096 (4KiB)",
      type=int,
      default=4096)
  common.add_argument(
      "-d",
      "--duration",
      help="Duration of profile (ms). 0 to run until interrupted. "
      "Default: until interrupted by user.",
      type=int,
      default=0)
  # This flag is a no-op now. We never start heapprofd explicitly using system
  # properties.
  common.add_argument(
      "--no-start", help="Do not start heapprofd.", action='store_true')
  common.add_argument(
      "-p",
      "--pid",
      help="Comma-separated list of PIDs to "
      "profile.",
      metavar="PIDS")
  common.add_argument(
      "-n",
      "--name",
      help="Comma-separated list of process "
      "names to profile.",
      metavar="NAMES")
  common.add_argument(
      "-c",
      "--continuous-dump",
      help="Dump interval in ms. 0 to disable continuous dump.",
      type=int,
      default=0)
  common.add_argument(
      "--heaps",
      help="Comma-separated list of heaps to collect, e.g: libc.malloc,com.android.art. "
      "Requires Android 12.",
      metavar="HEAPS")
  common.add_argument(
      "--all-heaps",
      action="store_true",
      help="Collect allocations from all heaps registered by target.")
  common.add_argument(
      "--no-android-tree-symbolization",
      action="store_true",
      help="Do not symbolize using currently lunched target in the "
      "Android tree.")
  common.add_argument(
      "--disable-selinux",
      action="store_true",
      help="Disable SELinux enforcement for duration of "
      "profile.")
  common.add_argument(
      "--no-versions",
      action="store_true",
      help="Do not get version information about APKs.")
  common.add_argument(
      "--no-running",
      action="store_true",
      help="Do not target already running processes. Requires Android 11.")
  common.add_argument(
      "--no-startup",
      action="store_true",
      help="Do not target processes that start during "
      "the profile. Requires Android 11.")
  common.add_argument(
      "--shmem-size",
      help="Size of buffer between client and "
      "heapprofd. Default 8MiB. Needs to be a power of two "
      "multiple of 4096, at least 8192.",
      type=int,
      default=8 * 1048576)
  common.add_argument(
      "--block-client",
      help="When buffer is full, block the "
      "client to wait for buffer space. Use with caution as "
      "this can significantly slow down the client. "
      "This is the default",
      action="store_true")
  common.add_argument(
      "--block-client-timeout",
      help="If --block-client is given, do not block any allocation for "
      "longer than this timeout (us).",
      type=int)
  common.add_argument(
      "--no-block-client",
      help="When buffer is full, stop the "
      "profile early.",
      action="store_true")
  common.add_argument(
      "--idle-allocations",
      help="Keep track of how many "
      "bytes were unused since the last dump, per "
      "callstack",
      action="store_true")
  common.add_argument(
      "--dump-at-max",
      help="Dump the maximum memory usage "
      "rather than at the time of the dump.",
      action="store_true")
  common.add_argument(
      "--disable-fork-teardown",
      help="Do not tear down client in forks. This can be useful for programs "
      "that use vfork. Android 11+ only.",
      action="store_true")
  common.add_argument(
      "--simpleperf",
      action="store_true",
      help="Get simpleperf profile of heapprofd. This is "
      "only for heapprofd development.")
  common.add_argument(
      "--traceconv-binary", help="Path to local trace to text. For debugging.")
  common.add_argument(
      "--no-annotations",
      help="Do not suffix the pprof function names with Android ART mode "
      "annotations such as [jit].",
      action="store_true")
  common.add_argument(
      "--print-config",
      action="store_true",
      help="Print config instead of running. For debugging.")
  common.add_argument(
      "-o",
      "--output",
      help="Output directory.",
      metavar="DIRECTORY",
      default=None)
  common.add_argument(
      "--print-options", action="store_true", help=argparse.SUPPRESS)

  parser = argparse.ArgumentParser(
      parents=[common],
      description="""Collect a heap profile

  The PERFETTO_PROGUARD_MAP=packagename=map_filename.txt[:packagename=map_filename.txt...] environment variable can be used to pass proguard deobfuscation maps for different packages.""",
      formatter_class=argparse.RawDescriptionHelpFormatter)

  subparsers = parser.add_subparsers(dest='subcommand')
  subparsers.required = False
  subparsers.add_parser(
      'android',
      parents=[common],
      help='Profile a process on a connected Android device via adb (default).',
      formatter_class=argparse.RawDescriptionHelpFormatter)

  host_parser = subparsers.add_parser(
      'host',
      parents=[common],
      help='Profile a local Linux process via LD_PRELOAD.',
      formatter_class=argparse.RawDescriptionHelpFormatter)
  host_parser.add_argument(
      '--preload-library',
      help='Path to libheapprofd_glibc_preload.so. '
      'If omitted the prebuilt is downloaded automatically.',
      default=None)
  host_parser.add_argument(
      '--tracebox-binary',
      help='Path to local tracebox binary. For debugging.',
      default=None)
  # Remainder after '--' is the command to launch (e.g. '-- mybinary arg1').
  host_parser.add_argument(
      'cmd', nargs=argparse.REMAINDER, help=argparse.SUPPRESS)

  args = parser.parse_args(argv[1:])
  if args.print_options:
    print_options(parser)
    return 0

  # Default to 'android' for backward compatibility with callers that do not
  # pass a subcommand.
  if args.subcommand is None:
    args.subcommand = 'android'

  # For host mode, extract the trailing command and infer process name from it.
  cmd = None
  if args.subcommand == 'host':
    if sys.platform != 'linux':
      print(
          'FATAL: host subcommand is only supported on Linux.', file=sys.stderr)
      return 1
    cmd = list(args.cmd)
    if cmd and cmd[0] == '--':
      cmd.pop(0)
    cmd = cmd if cmd else None
    if cmd is None:
      print(
          'FATAL: host subcommand requires a command after --.',
          file=sys.stderr)
      print(
          '  heap_profile host [flags] -- mybinary arg1 arg2', file=sys.stderr)
      return 1
    if args.name is None:
      args.name = os.path.basename(cmd[0])

  fail = False
  if args.block_client and args.no_block_client:
    print(
        "FATAL: Both block-client and no-block-client given.", file=sys.stderr)
    fail = True
  if args.pid is None and args.name is None:
    print("FATAL: Neither PID nor NAME given.", file=sys.stderr)
    fail = True
  if args.duration is None:
    print("FATAL: No duration given.", file=sys.stderr)
    fail = True
  if args.interval is None:
    print("FATAL: No interval given.", file=sys.stderr)
    fail = True
  if args.shmem_size % 4096:
    print("FATAL: shmem-size is not a multiple of 4096.", file=sys.stderr)
    fail = True
  if args.shmem_size < 8192:
    print("FATAL: shmem-size is less than 8192.", file=sys.stderr)
    fail = True
  if args.shmem_size & (args.shmem_size - 1):
    print("FATAL: shmem-size is not a power of two.", file=sys.stderr)
    fail = True
  target_cfg = ""
  if not args.no_block_client:
    target_cfg += CFG_INDENT + "block_client: true\n"
  if args.block_client_timeout:
    target_cfg += (
        CFG_INDENT +
        "block_client_timeout_us: %s\n" % args.block_client_timeout)
  if args.no_startup:
    target_cfg += CFG_INDENT + "no_startup: true\n"
  if args.no_running:
    target_cfg += CFG_INDENT + "no_running: true\n"
  if args.dump_at_max:
    target_cfg += CFG_INDENT + "dump_at_max: true\n"
  if args.disable_fork_teardown:
    target_cfg += CFG_INDENT + "disable_fork_teardown: true\n"
  if args.all_heaps:
    target_cfg += CFG_INDENT + "all_heaps: true\n"
  if args.pid:
    for pid in args.pid.split(','):
      try:
        pid = int(pid)
      except ValueError:
        print("FATAL: invalid PID %s" % pid, file=sys.stderr)
        fail = True
      target_cfg += CFG_INDENT + 'pid: {}\n'.format(pid)
  if args.name:
    for name in args.name.split(','):
      target_cfg += CFG_INDENT + 'process_cmdline: "{}"\n'.format(name)
  if args.heaps:
    for heap in args.heaps.split(','):
      target_cfg += CFG_INDENT + 'heaps: "{}"\n'.format(heap)

  if fail:
    parser.print_help()
    return 1

  traceconv_binary = args.traceconv_binary

  if args.continuous_dump:
    target_cfg += CONTINUOUS_DUMP.format(dump_interval=args.continuous_dump)
  cfg = CFG.format(
      interval=args.interval,
      duration=args.duration,
      target_cfg=target_cfg,
      shmem_size=args.shmem_size)
  # android.packages_list is Android-only.
  if args.subcommand == 'android' and not args.no_versions:
    cfg += PACKAGES_LIST_CFG

  if args.print_config:
    print(cfg)
    return 0

  # Do this AFTER print_config so we do not download traceconv only to
  # print out the config.
  if traceconv_binary is None:
    traceconv_binary = get_perfetto_prebuilt(TRACECONV_MANIFEST, soft_fail=True)

  if args.subcommand == 'host':
    return linux_main(args, cfg, cmd, traceconv_binary)

  # --- Android path ---

  known_issues = maybe_known_issues()
  if known_issues:
    print('If you are experiencing problems, please see the known issues for '
          'your release: {}.'.format(known_issues))

  # TODO(fmayer): Maybe feature detect whether we can remove traces instead of
  # this.
  uuid_trace = release_or_newer('R')
  if uuid_trace:
    profile_device_path = '/data/misc/perfetto-traces/profile-' + UUID
  else:
    user = subprocess.check_output(['adb', 'shell',
                                    'whoami']).decode('utf-8').strip()
    profile_device_path = '/data/misc/perfetto-traces/profile-' + user

  perfetto_cmd = ('CFG=\'{cfg}\'; echo ${{CFG}} | '
                  'perfetto --txt -c - -o ' + profile_device_path + ' -d')

  if args.disable_selinux:
    enforcing = subprocess.check_output(['adb', 'shell',
                                         'getenforce']).decode('utf-8').strip()
    atexit.register(
        subprocess.check_call,
        ['adb', 'shell', 'su root setenforce %s' % enforcing])
    subprocess.check_call(['adb', 'shell', 'su root setenforce 0'])

  if args.simpleperf:
    subprocess.check_call([
        'adb', 'shell', 'mkdir -p /data/local/tmp/heapprofd_profile && '
        'cd /data/local/tmp/heapprofd_profile &&'
        '(nohup simpleperf record -g -p $(pidof heapprofd) 2>&1 &) '
        '> /dev/null'
    ])

  profile_target = PROFILE_LOCAL_PATH
  if args.output is not None:
    profile_target = args.output
  else:
    os.mkdir(profile_target)

  if not os.path.isdir(profile_target):
    print(
        "Output directory {} not found".format(profile_target), file=sys.stderr)
    return 1

  if os.listdir(profile_target):
    print(
        "Output directory {} not empty".format(profile_target), file=sys.stderr)
    return 1

  perfetto_pid = subprocess.check_output(
      ['adb', 'exec-out', perfetto_cmd.format(cfg=cfg)]).strip()
  try:
    perfetto_pid = int(perfetto_pid.strip())
  except ValueError:
    print("Failed to invoke perfetto: {}".format(perfetto_pid), file=sys.stderr)
    return 1

  old_handler = signal.signal(signal.SIGINT, sigint_handler)
  print("Profiling active. Press Ctrl+C to terminate.")
  print("You may disconnect your device.")
  print()
  exists = True
  device_connected = True
  while not device_connected or (exists and not IS_INTERRUPTED):
    exists = subprocess.call(
        ['adb', 'shell', '[ -d /proc/{} ]'.format(perfetto_pid)], **NOOUT) == 0
    device_connected = subprocess.call(['adb', 'shell', 'true'], **NOOUT) == 0
    time.sleep(1)
  print("Waiting for profiler shutdown...")
  signal.signal(signal.SIGINT, old_handler)
  if IS_INTERRUPTED:
    # Not check_call because it could have existed in the meantime.
    subprocess.call(['adb', 'shell', 'kill', '-INT', str(perfetto_pid)])
  if args.simpleperf:
    subprocess.check_call(['adb', 'shell', 'killall', '-INT', 'simpleperf'])
    print("Waiting for simpleperf to exit.")
    while subprocess.call(
        ['adb', 'shell', '[ -f /proc/$(pidof simpleperf)/exe ]'], **NOOUT) == 0:
      time.sleep(1)
    subprocess.check_call(
        ['adb', 'pull', '/data/local/tmp/heapprofd_profile', profile_target])
    print("Pulled simpleperf profile to " + profile_target +
          "/heapprofd_profile")

  # Wait for perfetto cmd to return.
  while exists:
    exists = subprocess.call(
        ['adb', 'shell', '[ -d /proc/{} ]'.format(perfetto_pid)]) == 0
    time.sleep(1)

  profile_host_path = os.path.join(profile_target, 'raw-trace')
  subprocess.check_call(['adb', 'pull', profile_device_path, profile_host_path],
                        stdout=NULL)
  if uuid_trace:
    subprocess.check_call(['adb', 'shell', 'rm', profile_device_path],
                          stdout=NULL)

  return process_trace(
      profile_host_path,
      profile_target,
      traceconv_binary,
      args,
      android_mode=True)


if __name__ == '__main__':
  sys.exit(main(sys.argv))