path: root/js/src/devtools/rootAnalysis/mach_commands.py

# -*- coding: utf-8 -*-

# 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 absolute_import, print_function, unicode_literals

import argparse
import json
import os
import textwrap

from mach.base import FailedCommandError, MachError
from mach.decorators import (
    CommandArgument,
    CommandProvider,
    Command,
    SubCommand,
)
from mach.registrar import Registrar

from mozbuild.mozconfig import MozconfigLoader
from mozbuild.base import MachCommandBase

# Command files like this are listed in build/mach_bootstrap.py in alphabetical
# order, but we need to access commands earlier in the sorted order to grab
# their arguments. Force them to load now.
import mozbuild.artifact_commands  # NOQA: F401
import mozbuild.build_commands  # NOQA: F401


# Use a decorator to copy command arguments off of the named command. Instead
# of a decorator, this could be straight code that edits eg
# MachCommands.build_shell._mach_command.arguments, but that looked uglier.
def inherit_command_args(command, subcommand=None):
    """Decorator for inheriting all command-line arguments from `mach build`.

    This should come earlier in the source file than @Command or @SubCommand,
    because it relies on that decorator having run first."""

    def inherited(func):
        handler = Registrar.command_handlers.get(command)
        if handler is not None and subcommand is not None:
            handler = handler.subcommand_handlers.get(subcommand)
        if handler is None:
            raise MachError(
                "{} command unknown or not yet loaded".format(
                    command if subcommand is None else command + " " + subcommand
                )
            )
        func._mach_command.arguments.extend(handler.arguments)
        return func

    return inherited


@CommandProvider
class MachCommands(MachCommandBase):
    @property
    def state_dir(self):
        return os.environ.get("MOZBUILD_STATE_PATH", os.path.expanduser("~/.mozbuild"))

    @property
    def tools_dir(self):
        if os.environ.get("MOZ_FETCHES_DIR"):
            # In automation, tools are provided by toolchain dependencies.
            return os.path.join(os.environ["HOME"], os.environ["MOZ_FETCHES_DIR"])

        # In development, `mach hazard bootstrap` installs the tools separately
        # to avoid colliding with the "main" compiler versions, which can
        # change separately (and the precompiled sixgill and compiler version
        # must match exactly).
        return os.path.join(self.state_dir, "hazard-tools")

    @property
    def sixgill_dir(self):
        return os.path.join(self.tools_dir, "sixgill")

    @property
    def gcc_dir(self):
        return os.path.join(self.tools_dir, "gcc")

    @property
    def script_dir(self):
        return os.path.join(self.topsrcdir, "js/src/devtools/rootAnalysis")

    def work_dir(self, application, given):
        if given is not None:
            return given
        return os.path.join(self.topsrcdir, "haz-" + application)

    def ensure_dir_exists(self, dir):
        os.makedirs(dir, exist_ok=True)
        return dir

    # Force the use of hazard-compatible installs of tools.
    def setup_env_for_tools(self, env):
        gccbin = os.path.join(self.gcc_dir, "bin")
        env["CC"] = os.path.join(gccbin, "gcc")
        env["CXX"] = os.path.join(gccbin, "g++")
        env["PATH"] = "{sixgill_dir}/usr/bin:{gccbin}:{PATH}".format(
            sixgill_dir=self.sixgill_dir, gccbin=gccbin, PATH=env["PATH"]
        )
        env["LD_LIBRARY_PATH"] = "{}/lib64".format(self.gcc_dir)

    @Command(
        "hazards",
        category="build",
        order="declaration",
        description="Commands for running the static analysis for GC rooting hazards",
    )
    def hazards(self):
        """Commands related to performing the GC rooting hazard analysis"""
        print("See `mach hazards --help` for a list of subcommands")

    @inherit_command_args("artifact", "toolchain")
    @SubCommand(
        "hazards",
        "bootstrap",
        description="Install prerequisites for the hazard analysis",
    )
    def bootstrap(self, **kwargs):
        orig_dir = os.getcwd()
        os.chdir(self.ensure_dir_exists(self.tools_dir))
        try:
            kwargs["from_build"] = ("linux64-gcc-sixgill", "linux64-gcc-8")
            self._mach_context.commands.dispatch(
                "artifact", self._mach_context, subcommand="toolchain", **kwargs
            )
        finally:
            os.chdir(orig_dir)

    @inherit_command_args("build")
    @SubCommand(
        "hazards", "build-shell", description="Build a shell for the hazard analysis"
    )
    @CommandArgument(
        "--mozconfig",
        default=None,
        metavar="FILENAME",
        help="Build with the given mozconfig.",
    )
    def build_shell(self, **kwargs):
        """Build a JS shell to use to run the rooting hazard analysis."""
        # The JS shell requires some specific configuration settings to execute
        # the hazard analysis code, and configuration is done via mozconfig.
        # Subprocesses find MOZCONFIG in the environment, so we can't just
        # modify the settings in this process's loaded version. Pass it through
        # the environment.

        default_mozconfig = "js/src/devtools/rootAnalysis/mozconfig.haz_shell"
        mozconfig_path = (
            kwargs.pop("mozconfig", None)
            or os.environ.get("MOZCONFIG")
            or default_mozconfig
        )
        mozconfig_path = os.path.join(self.topsrcdir, mozconfig_path)
        loader = MozconfigLoader(self.topsrcdir)
        mozconfig = loader.read_mozconfig(mozconfig_path)

        # Validate the mozconfig settings in case the user overrode the default.
        configure_args = mozconfig["configure_args"]
        if "--enable-ctypes" not in configure_args:
            raise FailedCommandError(
                "ctypes required in hazard JS shell, mozconfig=" + mozconfig_path
            )

        # Transmit the mozconfig location to build subprocesses.
        os.environ["MOZCONFIG"] = mozconfig_path

        self.setup_env_for_tools(os.environ)

        # Set a default objdir for the shell, for developer builds.
        os.environ.setdefault(
            "MOZ_OBJDIR", os.path.join(self.topsrcdir, "obj-haz-shell")
        )

        return self._mach_context.commands.dispatch(
            "build", self._mach_context, **kwargs
        )

    def read_json_file(self, filename):
        with open(filename) as fh:
            return json.load(fh)

    def ensure_shell(self, objdir):
        if objdir is None:
            objdir = os.path.join(self.topsrcdir, "obj-haz-shell")

        try:
            binaries = self.read_json_file(os.path.join(objdir, "binaries.json"))
            info = [b for b in binaries["programs"] if b["program"] == "js"][0]
            return os.path.join(objdir, info["install_target"], "js")
        except (OSError, KeyError):
            raise FailedCommandError(
                """\
no shell found in %s -- must build the JS shell with `mach hazards build-shell` first"""
                % objdir
            )

    @inherit_command_args("build")
    @SubCommand(
        "hazards",
        "gather",
        description="Gather analysis data by compiling the given application",
    )
    @CommandArgument(
        "--application", default="browser", help="Build the given application."
    )
    @CommandArgument(
        "--haz-objdir", default=None, help="Write object files to this directory."
    )
    @CommandArgument(
        "--work-dir", default=None, help="Directory for output and working files."
    )
    def gather_hazard_data(self, **kwargs):
        """Gather analysis information by compiling the tree"""
        application = kwargs["application"]
        objdir = kwargs["haz_objdir"]
        if objdir is None:
            objdir = os.environ.get("HAZ_OBJDIR")
        if objdir is None:
            objdir = os.path.join(self.topsrcdir, "obj-analyzed-" + application)

        work_dir = self.work_dir(application, kwargs["work_dir"])
        self.ensure_dir_exists(work_dir)
        with open(os.path.join(work_dir, "defaults.py"), "wt") as fh:
            data = textwrap.dedent(
                """\
                analysis_scriptdir = "{script_dir}"
                objdir = "{objdir}"
                source = "{srcdir}"
                sixgill = "{sixgill_dir}/usr/libexec/sixgill"
                sixgill_bin = "{sixgill_dir}/usr/bin"
                gcc_bin = "{gcc_dir}/bin"
            """
            ).format(
                script_dir=self.script_dir,
                objdir=objdir,
                srcdir=self.topsrcdir,
                sixgill_dir=self.sixgill_dir,
                gcc_dir=self.gcc_dir,
            )
            fh.write(data)

        buildscript = " ".join(
            [
                self.topsrcdir + "/mach hazards compile",
                "--application=" + application,
                "--haz-objdir=" + objdir,
            ]
        )
        args = [
            os.path.join(self.script_dir, "analyze.py"),
            "dbs",
            "--upto",
            "dbs",
            "-v",
            "--buildcommand=" + buildscript,
        ]

        return self.run_process(args=args, cwd=work_dir, pass_thru=True)

    @inherit_command_args("build")
    @SubCommand("hazards", "compile", description=argparse.SUPPRESS)
    @CommandArgument(
        "--mozconfig",
        default=None,
        metavar="FILENAME",
        help="Build with the given mozconfig.",
    )
    @CommandArgument(
        "--application", default="browser", help="Build the given application."
    )
    @CommandArgument(
        "--haz-objdir",
        default=os.environ.get("HAZ_OBJDIR"),
        help="Write object files to this directory.",
    )
    def inner_compile(self, **kwargs):
        """Build a source tree and gather analysis information while running
        under the influence of the analysis collection server."""

        env = os.environ

        # Check whether we are running underneath the manager (and therefore
        # have a server to talk to).
        if "XGILL_CONFIG" not in env:
            raise Exception(
                "no sixgill manager detected. `mach hazards compile` "
                + "should only be run from `mach hazards gather`"
            )

        app = kwargs.pop("application")
        default_mozconfig = "js/src/devtools/rootAnalysis/mozconfig.%s" % app
        mozconfig_path = (
            kwargs.pop("mozconfig", None) or env.get("MOZCONFIG") or default_mozconfig
        )
        mozconfig_path = os.path.join(self.topsrcdir, mozconfig_path)

        # Validate the mozconfig.

        # Require an explicit --enable-application=APP (even if you just
        # want to build the default browser application.)
        loader = MozconfigLoader(self.topsrcdir)
        mozconfig = loader.read_mozconfig(mozconfig_path)
        configure_args = mozconfig["configure_args"]
        if "--enable-application=%s" % app not in configure_args:
            raise Exception("mozconfig %s builds wrong project" % mozconfig_path)
        if not any("--with-compiler-wrapper" in a for a in configure_args):
            raise Exception("mozconfig must wrap compiles")

        # Communicate mozconfig to build subprocesses.
        env["MOZCONFIG"] = os.path.join(self.topsrcdir, mozconfig_path)

        # hazard mozconfigs need to find binaries in .mozbuild
        env["MOZBUILD_STATE_PATH"] = self.state_dir

        # Suppress the gathering of sources, to save disk space and memory.
        env["XGILL_NO_SOURCE"] = "1"

        self.setup_env_for_tools(env)

        if "haz_objdir" in kwargs:
            env["MOZ_OBJDIR"] = kwargs.pop("haz_objdir")

        return self._mach_context.commands.dispatch(
            "build", self._mach_context, **kwargs
        )

    @SubCommand(
        "hazards", "analyze", description="Analyzed gathered data for rooting hazards"
    )
    @CommandArgument(
        "--application",
        default="browser",
        help="Analyze the output for the given application.",
    )
    @CommandArgument(
        "--shell-objdir",
        default=None,
        help="objdir containing the optimized JS shell for running the analysis.",
    )
    @CommandArgument(
        "--work-dir", default=None, help="Directory for output and working files."
    )
    def analyze(self, application, shell_objdir, work_dir):
        """Analyzed gathered data for rooting hazards"""

        shell = self.ensure_shell(shell_objdir)
        args = [
            os.path.join(self.script_dir, "analyze.py"),
            "--js",
            shell,
            "gcTypes",
            "-v",
        ]

        self.setup_env_for_tools(os.environ)
        os.environ["LD_LIBRARY_PATH"] += ":" + os.path.dirname(shell)

        work_dir = self.work_dir(application, work_dir)
        return self.run_process(args=args, cwd=work_dir, pass_thru=True)

    @SubCommand(
        "hazards",
        "self-test",
        description="Run a self-test to verify hazards are detected",
    )
    @CommandArgument(
        "--shell-objdir",
        default=None,
        help="objdir containing the optimized JS shell for running the analysis.",
    )
    def self_test(self, shell_objdir):
        """Analyzed gathered data for rooting hazards"""
        shell = self.ensure_shell(shell_objdir)
        args = [
            os.path.join(self.script_dir, "run-test.py"),
            "-v",
            "--js",
            shell,
            "--sixgill",
            os.path.join(self.tools_dir, "sixgill"),
            "--gccdir",
            self.gcc_dir,
        ]

        self.setup_env_for_tools(os.environ)
        os.environ["LD_LIBRARY_PATH"] += ":" + os.path.dirname(shell)
        return self.run_process(args=args, pass_thru=True)