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 v58.2
HEAPPROFD_GLIBC_PRELOAD_MANIFEST = [{
    'arch':
        'linux-amd64',
    'file_name':
        'libheapprofd_glibc_preload.so',
    'file_size':
        1067488,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v58.2/linux-amd64/libheapprofd_glibc_preload.so',
    'sha256':
        'eb5c5649d54053ed4b08ec606c8bd9d4f272e440d009cde57bd62dfa8d323333',
    'platform':
        'linux',
    'machine': ['x86_64']
}, {
    'arch':
        'linux-arm',
    'file_name':
        'libheapprofd_glibc_preload.so',
    'file_size':
        631596,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v58.2/linux-arm/libheapprofd_glibc_preload.so',
    'sha256':
        '5069f0a8dd4ed830a33702e6f4dc2513e31a890c7d7e63ddbe20ce3192133ba6',
    'platform':
        'linux',
    'machine': ['armv6l', 'armv7l', 'armv8l']
}, {
    'arch':
        'linux-arm64',
    'file_name':
        'libheapprofd_glibc_preload.so',
    'file_size':
        1034480,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v58.2/linux-arm64/libheapprofd_glibc_preload.so',
    'sha256':
        '4ca10d32455973389d0f772f1c9ad8616b61eb46edc3b995a2825dee9fab2662',
    '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 v58.2
TRACEBOX_MANIFEST = [{
    'arch':
        'mac-amd64',
    'file_name':
        'tracebox',
    'file_size':
        2969848,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v58.2/mac-amd64/tracebox',
    'sha256':
        '545ab7efe47c185b4283810b2a1e751327176487e0c8161f993012798e4ae5ed',
    'platform':
        'darwin',
    'machine': ['x86_64']
}, {
    'arch':
        'mac-arm64',
    'file_name':
        'tracebox',
    'file_size':
        2675224,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v58.2/mac-arm64/tracebox',
    'sha256':
        '8a16b29f14d5ea0628107a9d49f5eb4a80746f33fe9073d29acbe670bbc0904f',
    'platform':
        'darwin',
    'machine': ['arm64']
}, {
    'arch':
        'linux-amd64',
    'file_name':
        'tracebox',
    'file_size':
        3686088,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v58.2/linux-amd64/tracebox',
    'sha256':
        '5348e5f3513dec2e70f02d3e4296cfed546e6ebc7f9a7cc6b5499f363b4aea03',
    'platform':
        'linux',
    'machine': ['x86_64']
}, {
    'arch':
        'linux-arm',
    'file_name':
        'tracebox',
    'file_size':
        2337104,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v58.2/linux-arm/tracebox',
    'sha256':
        'd4ab72fd27d033c79310336094a93b1287a543f4865ff1fd8604a09ab456637b',
    'platform':
        'linux',
    'machine': ['armv6l', 'armv7l', 'armv8l']
}, {
    'arch':
        'linux-arm64',
    'file_name':
        'tracebox',
    'file_size':
        3470168,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v58.2/linux-arm64/tracebox',
    'sha256':
        '2d21883e9c55818f851fd8c391afb9b366032b3110076b4fd41f31f30b5849fa',
    'platform':
        'linux',
    'machine': ['aarch64']
}, {
    'arch':
        'android-arm',
    'file_name':
        'tracebox',
    'file_size':
        2183800,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v58.2/android-arm/tracebox',
    'sha256':
        'dde682d536bc7259aeb21aea8a2cd3f4cec6dad55d056512da9d0bf4c5cfd3cb'
}, {
    'arch':
        'android-arm64',
    'file_name':
        'tracebox',
    'file_size':
        3203768,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v58.2/android-arm64/tracebox',
    'sha256':
        '51591371ae18dd141b596ff96bafa21b6ccb5918d4ef2078ddf9bbf4438c2a82'
}, {
    'arch':
        'android-x86',
    'file_name':
        'tracebox',
    'file_size':
        3674568,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v58.2/android-x86/tracebox',
    'sha256':
        '2fa334eec69e1564b410dbbf1851070d35b6b4f8fedc61368caedbd3357b7202'
}, {
    'arch':
        'android-x64',
    'file_name':
        'tracebox',
    'file_size':
        3352704,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v58.2/android-x64/tracebox',
    'sha256':
        'd9cb2f28334b48e499c9d6c0a3e06ac2e1b4db6f0f4f2b73720522eb79eee1cd'
}]

# ----- 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 v58.2
TRACECONV_MANIFEST = [{
    'arch':
        'mac-amd64',
    'file_name':
        'traceconv',
    'file_size':
        14854504,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v58.2/mac-amd64/trace_processor_shell',
    'sha256':
        '3927a2767eadd140db3ff4fe0dfbf1bde35c1f56501149cd367f5cee898bef27',
    'platform':
        'darwin',
    'machine': ['x86_64']
}, {
    'arch':
        'mac-arm64',
    'file_name':
        'traceconv',
    'file_size':
        13597976,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v58.2/mac-arm64/trace_processor_shell',
    'sha256':
        'd29864d1ba3b36855527bb1b0ca3aa7f703cdce338b9680bb922c5c151b358fa',
    'platform':
        'darwin',
    'machine': ['arm64']
}, {
    'arch':
        'linux-amd64',
    'file_name':
        'traceconv',
    'file_size':
        14897560,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v58.2/linux-amd64/trace_processor_shell',
    'sha256':
        '58042408e6cc861fb1a731c26bb082dc222285561eaa4e12a48a8b2b90dca7b9',
    'platform':
        'linux',
    'machine': ['x86_64']
}, {
    'arch':
        'linux-arm',
    'file_name':
        'traceconv',
    'file_size':
        10962664,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v58.2/linux-arm/trace_processor_shell',
    'sha256':
        '09683fed93a3452d9dac1f5165a592ec9fec82fba90be2c5dd764c8f9a449e33',
    'platform':
        'linux',
    'machine': ['armv6l', 'armv7l', 'armv8l']
}, {
    'arch':
        'linux-arm64',
    'file_name':
        'traceconv',
    'file_size':
        14086160,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v58.2/linux-arm64/trace_processor_shell',
    'sha256':
        '0e6e0c5452c505c8d46fe472fd196a0d17d963460727e2ce2013b02aa1309555',
    'platform':
        'linux',
    'machine': ['aarch64']
}, {
    'arch':
        'android-arm',
    'file_name':
        'traceconv',
    'file_size':
        10935412,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v58.2/android-arm/trace_processor_shell',
    'sha256':
        '57a854e15b1502db11fcd7adbb29fc8e729d2c9c362634d8bcdc2cb992c06142'
}, {
    'arch':
        'android-arm64',
    'file_name':
        'traceconv',
    'file_size':
        13838680,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v58.2/android-arm64/trace_processor_shell',
    'sha256':
        '45a8e1323816f8358ec9cc67ee441de88a31f18911bc7da4cf13b3f2baf0af06'
}, {
    'arch':
        'android-x86',
    'file_name':
        'traceconv',
    'file_size':
        15814036,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v58.2/android-x86/trace_processor_shell',
    'sha256':
        'bbe30e0505971c5c793ffea93f693a5144b17821002285e0466e3b6a417cca35'
}, {
    'arch':
        'android-x64',
    'file_name':
        'traceconv',
    'file_size':
        14611448,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v58.2/android-x64/trace_processor_shell',
    'sha256':
        'bec07db40716e705f7cd9451caf366d0e80d15322c59433cd72171a3422a72d1'
}, {
    'arch':
        'windows-amd64',
    'file_name':
        'traceconv.exe',
    'file_size':
        14439936,
    'url':
        'https://commondatastorage.googleapis.com/perfetto-luci-artifacts/v58.2/windows-amd64/trace_processor_shell.exe',
    'sha256':
        'adfa6bad3d72be3ba9b83fa2b17b69fa13b3ab1cad0f42e52b86188bd5f0f997',
    '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-$sha256. On subsequent
  invocations it just runs the cached version.

  The (short) SHA-256 is embedded in the cached file name so that several
  versions of the same tool can coexist on the same machine. This matters when
  e.g. two virtualenvs pin different Perfetto releases, or the //tools wrappers
  and the Python API request different versions: without the SHA in the name
  they would all map to the same path, clobber each other and trigger a
  re-download on every switch.
  """
  dir = os.path.join(
      os.path.expanduser('~'), '.local', 'share', 'perfetto', 'prebuilts')
  os.makedirs(dir, exist_ok=True)
  # Embed the SHA in the file name, preserving any extension (e.g. .exe) as the
  # last component since callers (and the OS, on Windows) rely on it.
  root, ext = os.path.splitext(file_name)
  bin_path = os.path.join(dir, '%s-%s%s' % (root, sha256[:16], ext))

  # The cached file is only ever created via an atomic rename after the SHA-256
  # has been verified, so if a file at this (SHA-named) path exists we can trust
  # it without recomputing the hash on every invocation.
  if os.path.exists(bin_path):
    return bin_path

  # 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)
  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 and heap_dump.* (pprof) files can be visualized with '
        'https://ui.perfetto.dev.')
  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))