1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
|
#!/usr/bin/env python
# Copyright 2020 The Chromium Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Downloads pgo profiles for optimizing official Chrome.
This script has the following responsibilities:
1. Download a requested profile if necessary.
2. Return a path to the current profile to feed to the build system.
3. Removed stale profiles (2 days) to save disk spaces because profiles are
large (~1GB) and updated frequently (~4 times a day).
"""
from __future__ import print_function
import argparse
import os
import sys
import time
_SRC_ROOT = os.path.abspath(
os.path.join(os.path.dirname(__file__), os.path.pardir))
sys.path.append(os.path.join(_SRC_ROOT, 'third_party', 'depot_tools'))
import download_from_google_storage
sys.path.append(os.path.join(_SRC_ROOT, 'build'))
import gn_helpers
# Absolute path to the directory that stores pgo related state files, which
# specifcies which profile to update and use.
_PGO_DIR = os.path.join(_SRC_ROOT, 'chrome', 'build')
# Absolute path to the directory that stores pgo profiles.
_PGO_PROFILE_DIR = os.path.join(_PGO_DIR, 'pgo_profiles')
def _read_profile_name(target):
"""Read profile name given a target.
Args:
target(str): The target name, such as win32, mac.
Returns:
Name of the profile to update and use, such as:
chrome-win32-master-67ad3c89d2017131cc9ce664a1580315517550d1.profdata.
"""
state_file = os.path.join(_PGO_DIR, '%s.pgo.txt' % target)
with open(state_file, 'r') as f:
profile_name = f.read().strip()
return profile_name
def _remove_unused_profiles(current_profile_name):
"""Removes unused profiles, except the current one, to save disk space."""
days = 2
expiration_duration = 60 * 60 * 24 * days
for f in os.listdir(_PGO_PROFILE_DIR):
if f == current_profile_name:
continue
p = os.path.join(_PGO_PROFILE_DIR, f)
age = time.time() - os.path.getmtime(p)
if age > expiration_duration:
print('Removing profile %s as it hasn\'t been used in the past %d days' %
(p, days))
os.remove(p)
def _update(args):
"""Update profile if necessary according to the state file.
Args:
args(dict): A dict of cmd arguments, such as target and gs_url_base.
Raises:
RuntimeError: If failed to download profiles from gcs.
"""
profile_name = args.override_filename or _read_profile_name(args.target)
profile_path = os.path.join(_PGO_PROFILE_DIR, profile_name)
if os.path.isfile(profile_path):
os.utime(profile_path, None)
return
gsutil = download_from_google_storage.Gsutil(
download_from_google_storage.GSUTIL_DEFAULT_PATH)
gs_path = 'gs://' + args.gs_url_base.strip('/') + '/' + profile_name
code = gsutil.call('cp', gs_path, profile_path)
if code != 0:
raise RuntimeError('gsutil failed to download "%s"' % gs_path)
_remove_unused_profiles(profile_name)
def _get_profile_path(args):
"""Returns an absolute path to the current profile.
Args:
args(dict): A dict of cmd arguments, such as target and gs_url_base.
Raises:
RuntimeError: If the current profile is missing.
"""
profile_name = args.override_filename or _read_profile_name(args.target)
profile_path = os.path.join(_PGO_PROFILE_DIR, profile_name)
if not os.path.isfile(profile_path):
raise RuntimeError(
'requested profile "%s" doesn\'t exist, please make sure '
'"checkout_pgo_profiles" is set to True in the "custom_vars" section '
'of your .gclient file, e.g.: \n'
'solutions = [ \n'
' { \n'
' "name": "src", \n'
' # ... \n'
' "custom_vars": { \n'
' "checkout_pgo_profiles": True, \n'
' }, \n'
' }, \n'
'], \n'
'and then run "gclient runhooks" to download it. You can also simply '
'disable the PGO optimizations by setting |chrome_pgo_phase = 0| in '
'your GN arguments.'%
profile_path)
os.utime(profile_path, None)
profile_path.rstrip(os.sep)
print(gn_helpers.ToGNString(profile_path))
def main():
parser = argparse.ArgumentParser(
description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter)
parser.add_argument(
'--target',
required=True,
choices=[
'win-arm64',
'win32',
'win64',
'mac',
'mac-arm',
'linux',
'android-arm32',
'android-arm64',
'android-desktop-x64',
],
help='Identifier of a specific target platform + architecture.')
parser.add_argument('--override-filename',
help='The filename to prefer instead of the sha1 file.')
subparsers = parser.add_subparsers()
parser_update = subparsers.add_parser('update')
parser_update.add_argument(
'--gs-url-base',
required=True,
help='The base GS URL to search for the profile.')
parser_update.set_defaults(func=_update)
parser_get_profile_path = subparsers.add_parser('get_profile_path')
parser_get_profile_path.set_defaults(func=_get_profile_path)
args = parser.parse_args()
return args.func(args)
if __name__ == '__main__':
sys.exit(main())
|