Bug 1253707 - Script to generate visual studio toolchain archive; r?ted draft
authorGregory Szorc <gps@mozilla.com>
Fri, 11 Mar 2016 15:00:02 -0800
changeset 340312 c596d07a280b1384b849eac486b710ffa490d503
parent 340311 8cf04c34b495fdebd4a5f0d18c3eb438169e8698
child 340313 6f11ec74972f89126accf02960acb27878517f2e
push id12938
push usergszorc@mozilla.com
push dateTue, 15 Mar 2016 04:41:37 +0000
reviewersted
bugs1253707
milestone48.0a1
Bug 1253707 - Script to generate visual studio toolchain archive; r?ted Previously, Windows toolchains and related dependencies (SDKs, etc) were installed on Windows builders by people responsible for maintaining those machines. This commit takes a step in a new direction. We introduce a script (complete with documentation) that can produce a zip archive (or any archive format if people want to implement support) of the toolchain files. Basically, you install Visual Studio 2015 Community, run the script, and produce a self-contained zip file containing everything from Microsoft you need to build Firefox. With a copy of this archive and an installation of MozillaBuild, it is possible to build Firefox on a fresh Windows installation. No time-consuming Visual Studio installation needed. The goal is to upload these archives to tooltool and have our Windows builders download and extract them at run-time. At which time, we can remove all the other Visual Studio and SDK files from builders because they don't need to be baked into the image. We may find tooltool's caching isn't good enough and we have to more aggressively caching the standalone toolchain files. But that is a problem for another day. Whatever happens, we'll need the functionality in this script to produce a self-contained archive of the toolchain. There are certainly files in the produced archive that aren't needed. I think perfect is the enemy of done and we can prune the archive over time, if wanted. MozReview-Commit-ID: EckEK1a6vA3
build/docs/index.rst
build/docs/toolchains.rst
build/windows_toolchain.py
--- a/build/docs/index.rst
+++ b/build/docs/index.rst
@@ -19,16 +19,17 @@ Important Concepts
    environment-variables
    build-targets
    python
    test_manifests
    mozinfo
    preprocessor
    jar-manifests
    defining-binaries
+   toolchains
 
 integrated development environment (IDE)
 ========================================
 .. toctree::
    :maxdepth: 1
 
    androideclipse
    cppeclipse
new file mode 100644
--- /dev/null
+++ b/build/docs/toolchains.rst
@@ -0,0 +1,53 @@
+.. _build_toolchains:
+
+===========================
+Creating Toolchain Archives
+===========================
+
+There are various scripts in the repository for producing archives
+of the build tools (e.g. compilers and linkers) required to build.
+
+Clang
+=====
+
+See the ``build/build-clang`` directory. Read ``build/build-clang/README``
+for more.
+
+Windows
+=======
+
+The ``build/windows_toolchain.py`` script is used to build and manage
+Windows toolchain archives containing Visual Studio executables, SDKs,
+etc.
+
+The way Firefox build automation works is an archive containing the
+toolchain is produced and uploaded to an internal Mozilla server. The
+build automation will download, verify, and extract this archive before
+building. The archive is self-contained so machines don't need to install
+Visual Studio, SDKs, or various other dependencies. Unfortunately,
+Microsoft's terms don't allow Mozilla to distribute this archive
+publicly. However, the same tool can be used to create your own copy.
+
+Configuring Your System
+-----------------------
+
+It is **highly** recommended to perform this process on a fresh installation
+of Windows 7 or 10 (such as in a VM). Installing all updates through
+Windows Update is not only acceptable - it is encouraged. Although it
+shouldn't matter.
+
+Next, install Visual Studio 2015 Community. The download link can be
+found at https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx.
+Be sure to follow these install instructions:
+
+1. Choose a ``Custom`` installation and click ``Next``
+2. Select ``Programming Languages`` -> ``Visual C++`` (make sure all sub items are
+   selected)
+3. Under ``Windows and Web Development`` uncheck everything except
+   ``Universal Windows App Development Tools`` and the items under it
+   (should be ``Tools (1.2)...`` and the ``Windows 10 SDK``).
+
+Once Visual Studio 2015 Community has been installed, from a checkout
+of mozilla-central, run the following to produce a ZIP archive::
+
+   $ ./mach python build/windows_toolchain.py create-zip vs2015.zip
new file mode 100644
--- /dev/null
+++ b/build/windows_toolchain.py
@@ -0,0 +1,261 @@
+#!/usr/bin/env python2.7
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+# This script is used to create and manipulate archives containing
+# files necessary to build Firefox on Windows (referred to as the
+# "Windows toolchain").
+#
+# When updating behavior of this script, remember to update the docs
+# in ``build/docs/toolchains.rst``.
+
+from __future__ import absolute_import, unicode_literals
+
+import hashlib
+import os
+import sys
+
+from mozpack.files import (
+    FileFinder,
+)
+from mozpack.mozjar import (
+    JarWriter,
+)
+import mozpack.path as mozpath
+
+
+# mozpack.match patterns for files under "Microsoft Visual Studio 14.0".
+VS_PATTERNS = [
+    {
+        'pattern': 'DIA SDK/bin/**',
+        # Various tools don't like spaces in filenames. So remove it.
+        'rewrite': [('DIA SDK/', 'DIASDK/')],
+        'ignore': (
+            'DIA SDK/bin/arm/**',
+        ),
+    },
+    {
+        'pattern': 'DIA SDK/idl/**',
+        'rewrite': [('DIA SDK/', 'DIASDK/')],
+    },
+    {
+        'pattern': 'DIA SDK/include/**',
+        'rewrite': [('DIA SDK/', 'DIASDK/')],
+    },
+    {
+        'pattern': 'DIA SDK/lib/**',
+        'rewrite': [('DIA SDK/', 'DIASDK/')],
+        'ignore': (
+            'DIA SDK/lib/arm/**',
+        ),
+    },
+    # ATL is needed by Breakpad.
+    {
+        'pattern': 'VC/atlmfc/include/**',
+    },
+    {
+        'pattern': 'VC/atlmfc/lib/atls.*',
+    },
+    {
+        'pattern': 'VC/atlmfc/lib/amd64/atls.*',
+    },
+    {
+        'pattern': 'VC/bin/**',
+        # We only care about compiling on amd64 for amd64 or x86 targets.
+        'ignore': (
+            'VC/bin/amd64_arm/**',
+            'VC/bin/arm/**',
+            'VC/bin/x86_arm/**',
+            'VC/bin/x86_amd64/**',
+        ),
+    },
+    {
+        'pattern': 'VC/include/**',
+    },
+    {
+        'pattern': 'VC/lib/**',
+        'ignore': (
+            'VC/lib/arm/**',
+            'VC/lib/onecore/**',
+            'VC/lib/store/**',
+        ),
+    },
+    {
+        'pattern': 'VC/redist/x64/Microsoft.VC140.CRT/**',
+    },
+    {
+        'pattern': 'VC/redist/x86/Microsoft.VC140.CRT/**',
+    },
+]
+
+SDK_RELEASE = '10.0.10586.0'
+
+# Files from the Windows 10 SDK to install.
+SDK_PATTERNS = [
+    {
+        'pattern': 'bin/x64/**',
+    },
+    {
+        'pattern': 'Include/%s/**' % SDK_RELEASE,
+    },
+    {
+        'pattern': 'Lib/%s/ucrt/x64/**' % SDK_RELEASE,
+    },
+    {
+        'pattern': 'Lib/%s/ucrt/x86/**' % SDK_RELEASE,
+    },
+    {
+        'pattern': 'Lib/%s/um/x64/**' % SDK_RELEASE,
+    },
+    {
+        'pattern': 'Lib/%s/um/x86/**' % SDK_RELEASE,
+    },
+    {
+        'pattern': 'Redist/D3D/**',
+    },
+    {
+        'pattern': 'Redist/ucrt/DLLs/x64/**',
+    },
+    {
+        'pattern': 'Redist/ucrt/DLLs/x86/**',
+    },
+]
+
+
+def find_vs_paths():
+    """Resolve source locations of files.
+
+    Returns a 2-tuple of (Visual Studio Path, SDK Path).
+    """
+    pf = os.environ.get('ProgramFiles(x86)')
+    if not pf:
+        raise Exception('No "ProgramFiles(x86)" environment variable. '
+                        'Not running on 64-bit Windows?')
+
+    vs_path = os.path.join(pf, 'Microsoft Visual Studio 14.0')
+    if not os.path.exists(vs_path):
+        raise Exception('%s does not exist; Visual Studio 2015 not installed?' %
+                        vs_path)
+
+    sdk_path = os.path.join(pf, 'Windows Kits', '10')
+    if not os.path.exists(sdk_path):
+        raise Exception('%s does not exist; Windows 10 SDK not installed?' %
+                        sdk_path)
+
+    return vs_path, sdk_path
+
+
+def resolve_files():
+    """Resolve the files that constitute a standalone toolchain.
+
+    This is a generator of (dest path, file) where the destination
+    path is relative and the file instance is a BaseFile from mozpack.
+    """
+    vs_path, sdk_path = find_vs_paths()
+
+    for entry in VS_PATTERNS:
+        finder = FileFinder(vs_path, find_executables=False,
+                            ignore=entry.get('ignore', []))
+        for p, f in finder.find(entry['pattern']):
+            assert p.startswith(('VC/', 'DIA SDK/'))
+
+            for source, dest in entry.get('rewrite', []):
+                p = p.replace(source, dest)
+
+            yield p.encode('utf-8'), f
+
+    for entry in SDK_PATTERNS:
+        finder = FileFinder(sdk_path, find_executables=False,
+                            ignore=entry.get('ignore', []))
+        for p, f in finder.find(entry['pattern']):
+            # We remove the SDK version from the path so we don't have
+            # to update other configs when we change the SDK version.
+            p = p.replace('/%s/' % SDK_RELEASE, '/')
+            relpath = 'SDK/%s' % p
+
+            yield relpath.encode('utf-8'), f
+
+
+def resolve_files_and_hash(manifest):
+    """Resolve files and hash their data.
+
+    This is a generator of 3-tuples of (relpath, data, mode).
+
+    As data is read, the manifest is populated with metadata.
+    Keys are set to the relative file path. Values are 2-tuples
+    of (data length, sha-256).
+    """
+    assert manifest == {}
+    for p, f in resolve_files():
+        data = f.read()
+
+        sha256 = hashlib.sha256()
+        sha256.update(data)
+        manifest[p] = (len(data), sha256.hexdigest())
+
+        yield p, data, f.mode
+
+
+def format_manifest(manifest):
+    """Return formatted SHA-256 manifests as a byte strings."""
+    sha256_lines = []
+    for path, (length, sha256) in sorted(manifest.items()):
+        sha256_lines.append(b'%s\t%d\t%s' % (sha256, length, path))
+
+    # Trailing newline.
+    sha256_lines.append(b'')
+
+    return b'\n'.join(sha256_lines)
+
+
+def write_zip(zip_path, prefix=None):
+    """Write toolchain data to a zip file."""
+    if isinstance(prefix, unicode):
+        prefix = prefix.encode('utf-8')
+
+    with JarWriter(file=zip_path, optimize=False, compress=5) as zip:
+        manifest = {}
+        for p, data, mode in resolve_files_and_hash(manifest):
+            print(p)
+            if prefix:
+                p = mozpath.join(prefix, p)
+
+            zip.add(p, data, mode=mode)
+
+        sha256_manifest = format_manifest(manifest)
+
+        sdk_path = b'SDK_VERSION'
+        sha256_path = b'MANIFEST.SHA256'
+        if prefix:
+            sdk_path = mozpath.join(prefix, sdk_path)
+            sha256_path = mozpath.join(prefix, sha256_path)
+
+        zip.add(sdk_path, SDK_RELEASE.encode('utf-8'))
+        zip.add(sha256_path, sha256_manifest)
+
+
+if __name__ == '__main__':
+    if len(sys.argv) != 3:
+        print('usage: %s create-zip <filename.zip>' % sys.argv[0])
+        sys.exit(1)
+
+    assert sys.argv[1] == 'create-zip'
+    destzip = sys.argv[2]
+    # TODO make prefix a CLI argument
+    write_zip(destzip, prefix='vs2015u1')
+
+    sha1 = hashlib.sha1()
+    sha256 = hashlib.sha256()
+    sha512 = hashlib.sha512()
+
+    with open(destzip, 'rb') as fh:
+        data = fh.read()
+        sha1.update(data)
+        sha256.update(data)
+        sha512.update(data)
+
+    print('Hashes of %s (size=%d)' % (destzip, len(data)))
+    print('SHA-1:   %s' % sha1.hexdigest())
+    print('SHA-256: %s' % sha256.hexdigest())
+    print('SHA-512: %s' % sha512.hexdigest())