linux: control PGO via command line argument

This is much more convenient.

Author: indygreg

README.rst

@@ -47,6 +47,8 @@ Instructions
 To build a Python distribution for Linux x64::
 
     $ ./build-linux.py
+    # With profile-guided optimizations (generated code should be faster):
+    $ ./build-linux.py --optimized
 
 To build a Python distribution for macOS::
 

build-linux.py

@@ -3,6 +3,7 @@
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
+import argparse
 import datetime
 import os
 import pathlib
@@ -22,6 +23,11 @@
 
 
 def bootstrap():
+    parser = argparse.ArgumentParser()
+    parser.add_argument('--optimized', action='store_true')
+
+    args = parser.parse_args()
+
     BUILD.mkdir(exist_ok=True)
     DIST.mkdir(exist_ok=True)
 
@@ -33,6 +39,10 @@ def bootstrap():
     os.environ['PYBUILD_BOOTSTRAPPED'] = '1'
     os.environ['PATH'] = '%s:%s' % (str(VENV / 'bin'), os.environ['PATH'])
     os.environ['PYTHONPATH'] = str(ROOT)
+
+    if args.optimized:
+        os.environ['PYBUILD_OPTIMIZED'] = '1'
+
     subprocess.run([str(PYTHON), __file__], check=True)
 
 
@@ -46,9 +56,19 @@ def run():
     subprocess.run(['make'],
                    cwd=str(MAKE_DIR), check=True)
 
-    source_path = BUILD / 'cpython-linux64.tar'
-    dest_path = DIST / ('cpython-%s-linux64-%s.tar.zst' % (
-        DOWNLOADS['cpython-3.7']['version'], now.strftime('%Y%m%dT%H%M')))
+    basename = 'cpython-linux64'
+    extra = ''
+
+    if 'PYBUILD_OPTIMIZED' in os.environ:
+        basename += '-pgo'
+        extra = '-pgo'
+
+    basename += '.tar'
+
+    source_path = BUILD / basename
+    dest_path = DIST / ('cpython-%s-linux64%s-%s.tar.zst' % (
+        DOWNLOADS['cpython-3.7']['version'], extra,
+        now.strftime('%Y%m%dT%H%M')))
 
     print('compressing Python archive to %s' % dest_path)
     with source_path.open('rb') as ifh, dest_path.open('wb') as ofh:

cpython-linux/Makefile

@@ -17,7 +17,7 @@ TOOLCHAIN_DEPENDS := \
     $(OUTDIR)/clang-linux64.tar \
     $(NULL)
 
-default: $(OUTDIR)/cpython-linux64.tar
+default: $(OUTDIR)/cpython-linux64$(if $(PYBUILD_OPTIMIZED),-pgo,).tar
 
 $(OUTDIR)/image-%.tar: $(HERE)/%.Dockerfile $(COMMON_DEPENDS)
 	$(BUILD) image-$*
@@ -88,3 +88,6 @@ PYTHON_DEPENDS := \
 
 $(OUTDIR)/cpython-$(PLATFORM).tar: $(TOOLCHAIN_DEPENDS) $(HERE)/build-cpython.sh $(PYTHON_DEPENDS)
 	$(BUILD) --platform $(PLATFORM) cpython
+
+$(OUTDIR)/cpython-$(PLATFORM)-pgo.tar: $(TOOLCHAIN_DEPENDS) $(HERE)/build-cpython.sh $(PYTHON_DEPENDS)
+	$(BUILD) --platform $(PLATFORM) --optimized cpython

cpython-linux/build.py

@@ -532,7 +532,7 @@ def process_setup_line(line):
     return bi
 
 
-def build_cpython(client, image, platform):
+def build_cpython(client, image, platform, optimized=False):
     """Build CPythin in a Docker image'"""
     python_archive = download_entry('cpython-3.7', BUILD)
 
@@ -587,10 +587,12 @@ def build_cpython(client, image, platform):
                                    archive_path='Makefile.extra')
 
         env = {
-            'CPYTHON_OPTIMIZED': '1',
             'PYTHON_VERSION': DOWNLOADS['cpython-3.7']['version'],
         }
 
+        if optimized:
+            env['CPYTHON_OPTIMIZED'] = '1'
+
         container_exec(container, '/build/build-cpython.sh',
                        environment=env)
 
@@ -617,7 +619,14 @@ def build_cpython(client, image, platform):
                                    '/build/out/python',
                                    archive_path='PYTHON.json')
 
-        dest_path = BUILD / ('cpython-%s.tar' % platform)
+        basename = 'cpython-%s' % platform
+
+        if optimized:
+            basename += '-pgo'
+
+        basename += '.tar'
+
+        dest_path = BUILD / basename
         data, stat = container.get_archive('/build/out/python')
 
         with dest_path.open('wb') as fh:
@@ -637,17 +646,21 @@ def main():
 
     parser = argparse.ArgumentParser()
     parser.add_argument('--platform')
+    parser.add_argument('--optimized', action='store_true')
     parser.add_argument('action')
 
     args = parser.parse_args()
 
     action = args.action
 
-    log_path = BUILD / ('build.%s.log' % action)
-    LOG_PREFIX[0] = action
+    name = action
     if args.platform:
-        log_path = BUILD / ('build.%s-%s.log' % (action, args.platform))
-        LOG_PREFIX[0] = '%s-%s' % (action, args.platform)
+        name += '-%s' % args.platform
+    if args.optimized:
+        name += '-pgo'
+
+    log_path = BUILD / ('build.%s.log' % name)
+    LOG_PREFIX[0] = name
 
     with log_path.open('wb') as log_fh:
         LOG_FH[0] = log_fh
@@ -676,7 +689,8 @@ def main():
             build_tcltk(client, get_image(client, 'build'), platform=args.platform)
 
         elif action == 'cpython':
-            build_cpython(client, get_image(client, 'build'), platform=args.platform)
+            build_cpython(client, get_image(client, 'build'), platform=args.platform,
+                          optimized=args.optimized)
 
         else:
             print('unknown build action: %s' % action)