Adding upstream version 86.0.1.upstream/86.0.1upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 597 insertions, 0 deletions

diff --git a/build/mach_bootstrap.py b/build/mach_bootstrap.py
new file mode 100644
index 0000000000..7cda9b8d19
--- /dev/null
+++ b/build/mach_bootstrap.py
@@ -0,0 +1,597 @@
+# 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/.
+
+from __future__ import division, print_function, unicode_literals
+
+import errno
+import json
+import math
+import os
+import platform
+import shutil
+import subprocess
+import sys
+import uuid
+
+if sys.version_info[0] < 3:
+    import __builtin__ as builtins
+else:
+    import builtins
+
+from types import ModuleType
+
+
+STATE_DIR_FIRST_RUN = """
+mach and the build system store shared state in a common directory on the
+filesystem. The following directory will be created:
+
+  {userdir}
+
+If you would like to use a different directory, hit CTRL+c and set the
+MOZBUILD_STATE_PATH environment variable to the directory you would like to
+use and re-run mach. For this change to take effect forever, you'll likely
+want to export this environment variable from your shell's init scripts.
+
+Press ENTER/RETURN to continue or CTRL+c to abort.
+""".lstrip()
+
+
+# Individual files providing mach commands.
+MACH_MODULES = [
+    "build/valgrind/mach_commands.py",
+    "devtools/shared/css/generated/mach_commands.py",
+    "dom/bindings/mach_commands.py",
+    "js/src/devtools/rootAnalysis/mach_commands.py",
+    "layout/tools/reftest/mach_commands.py",
+    "mobile/android/mach_commands.py",
+    "python/mach/mach/commands/commandinfo.py",
+    "python/mach/mach/commands/settings.py",
+    "python/mach_commands.py",
+    "python/mozboot/mozboot/mach_commands.py",
+    "python/mozbuild/mozbuild/artifact_commands.py",
+    "python/mozbuild/mozbuild/backend/mach_commands.py",
+    "python/mozbuild/mozbuild/build_commands.py",
+    "python/mozbuild/mozbuild/code_analysis/mach_commands.py",
+    "python/mozbuild/mozbuild/compilation/codecomplete.py",
+    "python/mozbuild/mozbuild/frontend/mach_commands.py",
+    "python/mozbuild/mozbuild/vendor/mach_commands.py",
+    "python/mozbuild/mozbuild/mach_commands.py",
+    "python/mozperftest/mozperftest/mach_commands.py",
+    "python/mozrelease/mozrelease/mach_commands.py",
+    "remote/mach_commands.py",
+    "taskcluster/mach_commands.py",
+    "testing/awsy/mach_commands.py",
+    "testing/condprofile/mach_commands.py",
+    "testing/firefox-ui/mach_commands.py",
+    "testing/geckodriver/mach_commands.py",
+    "testing/mach_commands.py",
+    "testing/marionette/mach_commands.py",
+    "testing/mochitest/mach_commands.py",
+    "testing/mozharness/mach_commands.py",
+    "testing/raptor/mach_commands.py",
+    "testing/talos/mach_commands.py",
+    "testing/tps/mach_commands.py",
+    "testing/web-platform/mach_commands.py",
+    "testing/xpcshell/mach_commands.py",
+    "toolkit/components/telemetry/tests/marionette/mach_commands.py",
+    "tools/browsertime/mach_commands.py",
+    "tools/compare-locales/mach_commands.py",
+    "tools/lint/mach_commands.py",
+    "tools/mach_commands.py",
+    "tools/moztreedocs/mach_commands.py",
+    "tools/phabricator/mach_commands.py",
+    "tools/power/mach_commands.py",
+    "tools/tryselect/mach_commands.py",
+    "tools/vcs/mach_commands.py",
+]
+
+
+CATEGORIES = {
+    "build": {
+        "short": "Build Commands",
+        "long": "Interact with the build system",
+        "priority": 80,
+    },
+    "post-build": {
+        "short": "Post-build Commands",
+        "long": "Common actions performed after completing a build.",
+        "priority": 70,
+    },
+    "testing": {
+        "short": "Testing",
+        "long": "Run tests.",
+        "priority": 60,
+    },
+    "ci": {
+        "short": "CI",
+        "long": "Taskcluster commands",
+        "priority": 59,
+    },
+    "devenv": {
+        "short": "Development Environment",
+        "long": "Set up and configure your development environment.",
+        "priority": 50,
+    },
+    "build-dev": {
+        "short": "Low-level Build System Interaction",
+        "long": "Interact with specific parts of the build system.",
+        "priority": 20,
+    },
+    "misc": {
+        "short": "Potpourri",
+        "long": "Potent potables and assorted snacks.",
+        "priority": 10,
+    },
+    "release": {
+        "short": "Release automation",
+        "long": "Commands for used in release automation.",
+        "priority": 5,
+    },
+    "disabled": {
+        "short": "Disabled",
+        "long": "The disabled commands are hidden by default. Use -v to display them. "
+        "These commands are unavailable for your current context, "
+        'run "mach <command>" to see why.',
+        "priority": 0,
+    },
+}
+
+
+def search_path(mozilla_dir, packages_txt):
+    with open(os.path.join(mozilla_dir, packages_txt)) as f:
+        packages = [line.rstrip().split(":") for line in f]
+
+    def handle_package(package):
+        if package[0] == "optional":
+            try:
+                for path in handle_package(package[1:]):
+                    yield path
+            except Exception:
+                pass
+
+        if package[0] in ("windows", "!windows"):
+            for_win = not package[0].startswith("!")
+            is_win = sys.platform == "win32"
+            if is_win == for_win:
+                for path in handle_package(package[1:]):
+                    yield path
+
+        if package[0] in ("python2", "python3"):
+            for_python3 = package[0].endswith("3")
+            is_python3 = sys.version_info[0] > 2
+            if is_python3 == for_python3:
+                for path in handle_package(package[1:]):
+                    yield path
+
+        if package[0] == "packages.txt":
+            assert len(package) == 2
+            for p in search_path(mozilla_dir, package[1]):
+                yield os.path.join(mozilla_dir, p)
+
+        if package[0].endswith(".pth"):
+            assert len(package) == 2
+            yield os.path.join(mozilla_dir, package[1])
+
+    for package in packages:
+        for path in handle_package(package):
+            yield path
+
+
+def mach_sys_path(mozilla_dir):
+    return [
+        os.path.join(mozilla_dir, path)
+        for path in search_path(mozilla_dir, "build/mach_virtualenv_packages.txt")
+    ]
+
+
+def bootstrap(topsrcdir, mozilla_dir=None):
+    if mozilla_dir is None:
+        mozilla_dir = topsrcdir
+
+    # Ensure we are running Python 2.7 or 3.5+. We put this check here so we
+    # generate a user-friendly error message rather than a cryptic stack trace
+    # on module import.
+    major, minor = sys.version_info[:2]
+    if (major == 2 and minor < 7) or (major == 3 and minor < 5):
+        print("Python 2.7 or Python 3.5+ is required to run mach.")
+        print("You are running Python", platform.python_version())
+        sys.exit(1)
+
+    # This directory was deleted in bug 1666345, but there may be some ignored
+    # files here. We can safely just delete it for the user so they don't have
+    # to clean the repo themselves.
+    deleted_dir = os.path.join(topsrcdir, "third_party", "python", "psutil")
+    if os.path.exists(deleted_dir):
+        shutil.rmtree(deleted_dir, ignore_errors=True)
+
+    # Global build system and mach state is stored in a central directory. By
+    # default, this is ~/.mozbuild. However, it can be defined via an
+    # environment variable. We detect first run (by lack of this directory
+    # existing) and notify the user that it will be created. The logic for
+    # creation is much simpler for the "advanced" environment variable use
+    # case. For default behavior, we educate users and give them an opportunity
+    # to react. We always exit after creating the directory because users don't
+    # like surprises.
+    sys.path[0:0] = mach_sys_path(mozilla_dir)
+    import mach.base
+    import mach.main
+    from mach.util import setenv
+    from mozboot.util import get_state_dir
+
+    # Set a reasonable limit to the number of open files.
+    #
+    # Some linux systems set `ulimit -n` to a very high number, which works
+    # well for systems that run servers, but this setting causes performance
+    # problems when programs close file descriptors before forking, like
+    # Python's `subprocess.Popen(..., close_fds=True)` (close_fds=True is the
+    # default in Python 3), or Rust's stdlib.  In some cases, Firefox does the
+    # same thing when spawning processes.  We would prefer to lower this limit
+    # to avoid such performance problems; processes spawned by `mach` will
+    # inherit the limit set here.
+    #
+    # The Firefox build defaults the soft limit to 1024, except for builds that
+    # do LTO, where the soft limit is 8192.  We're going to default to the
+    # latter, since people do occasionally do LTO builds on their local
+    # machines, and requiring them to discover another magical setting after
+    # setting up an LTO build in the first place doesn't seem good.
+    #
+    # This code mimics the code in taskcluster/scripts/run-task.
+    try:
+        import resource
+
+        # Keep the hard limit the same, though, allowing processes to change
+        # their soft limit if they need to (Firefox does, for instance).
+        (soft, hard) = resource.getrlimit(resource.RLIMIT_NOFILE)
+        # Permit people to override our default limit if necessary via
+        # MOZ_LIMIT_NOFILE, which is the same variable `run-task` uses.
+        limit = os.environ.get("MOZ_LIMIT_NOFILE")
+        if limit:
+            limit = int(limit)
+        else:
+            # If no explicit limit is given, use our default if it's less than
+            # the current soft limit.  For instance, the default on macOS is
+            # 256, so we'd pick that rather than our default.
+            limit = min(soft, 8192)
+        # Now apply the limit, if it's different from the original one.
+        if limit != soft:
+            resource.setrlimit(resource.RLIMIT_NOFILE, (limit, hard))
+    except ImportError:
+        # The resource module is UNIX only.
+        pass
+
+    from mozbuild.util import patch_main
+
+    patch_main()
+
+    def resolve_repository():
+        import mozversioncontrol
+
+        try:
+            # This API doesn't respect the vcs binary choices from configure.
+            # If we ever need to use the VCS binary here, consider something
+            # more robust.
+            return mozversioncontrol.get_repository_object(path=mozilla_dir)
+        except (mozversioncontrol.InvalidRepoPath, mozversioncontrol.MissingVCSTool):
+            return None
+
+    def pre_dispatch_handler(context, handler, args):
+        # If --disable-tests flag was enabled in the mozconfig used to compile
+        # the build, tests will be disabled. Instead of trying to run
+        # nonexistent tests then reporting a failure, this will prevent mach
+        # from progressing beyond this point.
+        if handler.category == "testing" and not handler.ok_if_tests_disabled:
+            from mozbuild.base import BuildEnvironmentNotFoundException
+
+            try:
+                from mozbuild.base import MozbuildObject
+
+                # all environments should have an instance of build object.
+                build = MozbuildObject.from_environment()
+                if build is not None and hasattr(build, "mozconfig"):
+                    ac_options = build.mozconfig["configure_args"]
+                    if ac_options and "--disable-tests" in ac_options:
+                        print(
+                            "Tests have been disabled by mozconfig with the flag "
+                            + '"ac_add_options --disable-tests".\n'
+                            + "Remove the flag, and re-compile to enable tests."
+                        )
+                        sys.exit(1)
+            except BuildEnvironmentNotFoundException:
+                # likely automation environment, so do nothing.
+                pass
+
+    def post_dispatch_handler(
+        context, handler, instance, success, start_time, end_time, depth, args
+    ):
+        """Perform global operations after command dispatch.
+
+
+        For now,  we will use this to handle build system telemetry.
+        """
+
+        # Don't finalize telemetry data if this mach command was invoked as part of
+        # another mach command.
+        if depth != 1:
+            return
+
+        _finalize_telemetry_glean(
+            context.telemetry, handler.name == "bootstrap", success
+        )
+        _finalize_telemetry_legacy(
+            context, instance, handler, success, start_time, end_time, topsrcdir
+        )
+
+    def populate_context(key=None):
+        if key is None:
+            return
+        if key == "state_dir":
+            state_dir = get_state_dir()
+            if state_dir == os.environ.get("MOZBUILD_STATE_PATH"):
+                if not os.path.exists(state_dir):
+                    print(
+                        "Creating global state directory from environment variable: %s"
+                        % state_dir
+                    )
+                    os.makedirs(state_dir, mode=0o770)
+            else:
+                if not os.path.exists(state_dir):
+                    if not os.environ.get("MOZ_AUTOMATION"):
+                        print(STATE_DIR_FIRST_RUN.format(userdir=state_dir))
+                        try:
+                            sys.stdin.readline()
+                        except KeyboardInterrupt:
+                            sys.exit(1)
+
+                    print("\nCreating default state directory: %s" % state_dir)
+                    os.makedirs(state_dir, mode=0o770)
+
+            return state_dir
+
+        if key == "local_state_dir":
+            return get_state_dir(srcdir=True)
+
+        if key == "topdir":
+            return topsrcdir
+
+        if key == "pre_dispatch_handler":
+            return pre_dispatch_handler
+
+        if key == "post_dispatch_handler":
+            return post_dispatch_handler
+
+        if key == "repository":
+            return resolve_repository()
+
+        raise AttributeError(key)
+
+    # Note which process is top-level so that recursive mach invocations can avoid writing
+    # telemetry data.
+    if "MACH_MAIN_PID" not in os.environ:
+        setenv("MACH_MAIN_PID", str(os.getpid()))
+
+    driver = mach.main.Mach(os.getcwd())
+    driver.populate_context_handler = populate_context
+
+    if not driver.settings_paths:
+        # default global machrc location
+        driver.settings_paths.append(get_state_dir())
+    # always load local repository configuration
+    driver.settings_paths.append(mozilla_dir)
+
+    for category, meta in CATEGORIES.items():
+        driver.define_category(category, meta["short"], meta["long"], meta["priority"])
+
+    repo = resolve_repository()
+
+    for path in MACH_MODULES:
+        # Sparse checkouts may not have all mach_commands.py files. Ignore
+        # errors from missing files.
+        try:
+            driver.load_commands_from_file(os.path.join(mozilla_dir, path))
+        except mach.base.MissingFileError:
+            if not repo or not repo.sparse_checkout_present():
+                raise
+
+    return driver
+
+
+def _finalize_telemetry_legacy(
+    context, instance, handler, success, start_time, end_time, topsrcdir
+):
+    """Record and submit legacy telemetry.
+
+    Parameterized by the raw gathered telemetry, this function handles persisting and
+    submission of the data.
+
+    This has been designated as "legacy" telemetry because modern telemetry is being
+    submitted with "Glean".
+    """
+    from mozboot.util import get_state_dir
+    from mozbuild.base import MozbuildObject
+    from mozbuild.telemetry import gather_telemetry
+    from mach.telemetry import is_telemetry_enabled, is_applicable_telemetry_environment
+
+    if not (
+        is_applicable_telemetry_environment() and is_telemetry_enabled(context.settings)
+    ):
+        return
+
+    if not isinstance(instance, MozbuildObject):
+        instance = MozbuildObject.from_environment()
+
+    command_attrs = getattr(context, "command_attrs", {})
+
+    # We gather telemetry for every operation.
+    data = gather_telemetry(
+        command=handler.name,
+        success=success,
+        start_time=start_time,
+        end_time=end_time,
+        mach_context=context,
+        instance=instance,
+        command_attrs=command_attrs,
+    )
+    if data:
+        telemetry_dir = os.path.join(get_state_dir(), "telemetry")
+        try:
+            os.mkdir(telemetry_dir)
+        except OSError as e:
+            if e.errno != errno.EEXIST:
+                raise
+        outgoing_dir = os.path.join(telemetry_dir, "outgoing")
+        try:
+            os.mkdir(outgoing_dir)
+        except OSError as e:
+            if e.errno != errno.EEXIST:
+                raise
+
+        with open(os.path.join(outgoing_dir, str(uuid.uuid4()) + ".json"), "w") as f:
+            json.dump(data, f, sort_keys=True)
+
+    # The user is performing a maintenance command, skip the upload
+    if handler.name in (
+        "bootstrap",
+        "doctor",
+        "mach-commands",
+        "vcs-setup",
+        "create-mach-environment",
+        "install-moz-phab",
+        # We call mach environment in client.mk which would cause the
+        # data submission to block the forward progress of make.
+        "environment",
+    ):
+        return False
+
+    if "TEST_MACH_TELEMETRY_NO_SUBMIT" in os.environ:
+        # In our telemetry tests, we want telemetry to be collected for analysis, but
+        # we don't want it submitted.
+        return False
+
+    state_dir = get_state_dir()
+
+    machpath = os.path.join(instance.topsrcdir, "mach")
+    with open(os.devnull, "wb") as devnull:
+        subprocess.Popen(
+            [
+                sys.executable,
+                machpath,
+                "python",
+                "--no-virtualenv",
+                os.path.join(topsrcdir, "build", "submit_telemetry_data.py"),
+                state_dir,
+            ],
+            stdout=devnull,
+            stderr=devnull,
+        )
+
+
+def _finalize_telemetry_glean(telemetry, is_bootstrap, success):
+    """Submit telemetry collected by Glean.
+
+    Finalizes some metrics (command success state and duration, system information) and
+    requests Glean to send the collected data.
+    """
+
+    from mach.telemetry import MACH_METRICS_PATH
+    from mozbuild.telemetry import (
+        get_cpu_brand,
+        get_distro_and_version,
+        get_psutil_stats,
+    )
+
+    mach_metrics = telemetry.metrics(MACH_METRICS_PATH)
+    mach_metrics.mach.duration.stop()
+    mach_metrics.mach.success.set(success)
+    system_metrics = mach_metrics.mach.system
+    system_metrics.cpu_brand.set(get_cpu_brand())
+    distro, version = get_distro_and_version()
+    system_metrics.distro.set(distro)
+    system_metrics.distro_version.set(version)
+
+    has_psutil, logical_cores, physical_cores, memory_total = get_psutil_stats()
+    if has_psutil:
+        # psutil may not be available (we allow `mach create-mach-environment`
+        # to fail to install it).
+        system_metrics.logical_cores.add(logical_cores)
+        system_metrics.physical_cores.add(physical_cores)
+        if memory_total is not None:
+            system_metrics.memory.accumulate(
+                int(math.ceil(float(memory_total) / (1024 * 1024 * 1024)))
+            )
+    telemetry.submit(is_bootstrap)
+
+
+# Hook import such that .pyc/.pyo files without a corresponding .py file in
+# the source directory are essentially ignored. See further below for details
+# and caveats.
+# Objdirs outside the source directory are ignored because in most cases, if
+# a .pyc/.pyo file exists there, a .py file will be next to it anyways.
+class ImportHook(object):
+    def __init__(self, original_import):
+        self._original_import = original_import
+        # Assume the source directory is the parent directory of the one
+        # containing this file.
+        self._source_dir = (
+            os.path.normcase(
+                os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
+            )
+            + os.sep
+        )
+        self._modules = set()
+
+    def __call__(self, name, globals=None, locals=None, fromlist=None, level=-1):
+        if sys.version_info[0] >= 3 and level < 0:
+            level = 0
+
+        # name might be a relative import. Instead of figuring out what that
+        # resolves to, which is complex, just rely on the real import.
+        # Since we don't know the full module name, we can't check sys.modules,
+        # so we need to keep track of which modules we've already seen to avoid
+        # to stat() them again when they are imported multiple times.
+        module = self._original_import(name, globals, locals, fromlist, level)
+
+        # Some tests replace modules in sys.modules with non-module instances.
+        if not isinstance(module, ModuleType):
+            return module
+
+        resolved_name = module.__name__
+        if resolved_name in self._modules:
+            return module
+        self._modules.add(resolved_name)
+
+        # Builtin modules don't have a __file__ attribute.
+        if not getattr(module, "__file__", None):
+            return module
+
+        # Note: module.__file__ is not always absolute.
+        path = os.path.normcase(os.path.abspath(module.__file__))
+        # Note: we could avoid normcase and abspath above for non pyc/pyo
+        # files, but those are actually rare, so it doesn't really matter.
+        if not path.endswith((".pyc", ".pyo")):
+            return module
+
+        # Ignore modules outside our source directory
+        if not path.startswith(self._source_dir):
+            return module
+
+        # If there is no .py corresponding to the .pyc/.pyo module we're
+        # loading, remove the .pyc/.pyo file, and reload the module.
+        # Since we already loaded the .pyc/.pyo module, if it had side
+        # effects, they will have happened already, and loading the module
+        # with the same name, from another directory may have the same side
+        # effects (or different ones). We assume it's not a problem for the
+        # python modules under our source directory (either because it
+        # doesn't happen or because it doesn't matter).
+        if not os.path.exists(module.__file__[:-1]):
+            if os.path.exists(module.__file__):
+                os.remove(module.__file__)
+            del sys.modules[module.__name__]
+            module = self(name, globals, locals, fromlist, level)
+
+        return module
+
+
+# Install our hook. This can be deleted when the Python 3 migration is complete.
+if sys.version_info[0] < 3:
+    builtins.__import__ = ImportHook(builtins.__import__)