aboutsummaryrefslogtreecommitdiffstats
path: root/python/servo/platform
diff options
context:
space:
mode:
Diffstat (limited to 'python/servo/platform')
-rw-r--r--python/servo/platform/__init__.py64
-rw-r--r--python/servo/platform/base.py34
-rw-r--r--python/servo/platform/linux.py171
-rw-r--r--python/servo/platform/macos.py36
-rw-r--r--python/servo/platform/windows.py98
5 files changed, 403 insertions, 0 deletions
diff --git a/python/servo/platform/__init__.py b/python/servo/platform/__init__.py
new file mode 100644
index 00000000000..84968550d00
--- /dev/null
+++ b/python/servo/platform/__init__.py
@@ -0,0 +1,64 @@
+# Copyright 2023 The Servo Project Developers. See the COPYRIGHT
+# file at the top-level directory of this distribution.
+#
+# Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+# http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+# <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+# option. This file may not be copied, modified, or distributed
+# except according to those terms.
+
+import platform
+
+from .base import Base
+from .windows import Windows
+
+
+def host_platform():
+ os_type = platform.system().lower()
+ if os_type == "linux":
+ os_type = "unknown-linux-gnu"
+ elif os_type == "darwin":
+ os_type = "apple-darwin"
+ elif os_type == "android":
+ os_type = "linux-androideabi"
+ elif os_type == "windows":
+ os_type = "pc-windows-msvc"
+ elif os_type == "freebsd":
+ os_type = "unknown-freebsd"
+ else:
+ os_type = "unknown"
+ return os_type
+
+
+def host_triple():
+ os_type = host_platform()
+ cpu_type = platform.machine().lower()
+ if cpu_type in ["i386", "i486", "i686", "i768", "x86"]:
+ cpu_type = "i686"
+ elif cpu_type in ["x86_64", "x86-64", "x64", "amd64"]:
+ cpu_type = "x86_64"
+ elif cpu_type == "arm":
+ cpu_type = "arm"
+ elif cpu_type == "aarch64":
+ cpu_type = "aarch64"
+ else:
+ cpu_type = "unknown"
+ return f"{cpu_type}-{os_type}"
+
+
+def get():
+ # We import the concrete platforms in if-statements here, because
+ # each one might have platform-specific imports which might not
+ # resolve on all platforms.
+ # TODO(mrobinson): We should do this for Windows too, once we
+ # stop relying on platform-specific code outside of this module.
+ # pylint: disable=import-outside-toplevel
+ if "windows-msvc" in host_triple():
+ return Windows()
+ if "linux-gnu" in host_triple():
+ from .linux import Linux
+ return Linux()
+ if "apple-darwin" in host_triple():
+ from .macos import MacOS
+ return MacOS()
+ return Base()
diff --git a/python/servo/platform/base.py b/python/servo/platform/base.py
new file mode 100644
index 00000000000..316c998b1db
--- /dev/null
+++ b/python/servo/platform/base.py
@@ -0,0 +1,34 @@
+# Copyright 2023 The Servo Project Developers. See the COPYRIGHT
+# file at the top-level directory of this distribution.
+#
+# Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+# http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+# <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+# option. This file may not be copied, modified, or distributed
+# except according to those terms.
+
+import subprocess
+
+
+class Base:
+ def _platform_bootstrap(self, _cache_dir: str, _force: bool) -> bool:
+ raise NotImplementedError("Bootstrap installation detection not yet available.")
+
+ def _platform_bootstrap_gstreamer(self, _cache_dir: str, _force: bool) -> bool:
+ raise NotImplementedError("GStreamer bootstrap support is not yet available for your OS.")
+
+ def _platform_is_gstreamer_installed(self) -> bool:
+ return subprocess.call(
+ ["pkg-config", "--atleast-version=1.16", "gstreamer-1.0"],
+ stdout=subprocess.PIPE, stderr=subprocess.PIPE) == 0
+
+ def bootstrap(self, cache_dir: str, force: bool):
+ if not self._platform_bootstrap(cache_dir, force):
+ print("Dependencies were already installed!")
+
+ def bootstrap_gstreamer(self, cache_dir: str, force: bool):
+ if not self._platform_bootstrap_gstreamer(cache_dir, force):
+ print("Dependencies were already installed!")
+
+ def is_gstreamer_installed(self) -> bool:
+ return self._platform_is_gstreamer_installed()
diff --git a/python/servo/platform/linux.py b/python/servo/platform/linux.py
new file mode 100644
index 00000000000..da1a83a3b27
--- /dev/null
+++ b/python/servo/platform/linux.py
@@ -0,0 +1,171 @@
+# Copyright 2023 The Servo Project Developers. See the COPYRIGHT
+# file at the top-level directory of this distribution.
+#
+# Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+# http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+# <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+# option. This file may not be copied, modified, or distributed
+# except according to those terms.
+
+import os
+import subprocess
+
+from typing import Tuple
+
+import distro
+import six
+
+from .base import Base
+
+# Please keep these in sync with the packages in README.md
+APT_PKGS = ['git', 'curl', 'autoconf', 'libx11-dev', 'libfreetype6-dev',
+ 'libgl1-mesa-dri', 'libglib2.0-dev', 'xorg-dev', 'gperf', 'g++',
+ 'build-essential', 'cmake', 'libssl-dev',
+ 'liblzma-dev', 'libxmu6', 'libxmu-dev',
+ "libxcb-render0-dev", "libxcb-shape0-dev", "libxcb-xfixes0-dev",
+ 'libgles2-mesa-dev', 'libegl1-mesa-dev', 'libdbus-1-dev',
+ 'libharfbuzz-dev', 'ccache', 'clang', 'libunwind-dev',
+ 'libgstreamer1.0-dev', 'libgstreamer-plugins-base1.0-dev',
+ 'libgstreamer-plugins-bad1.0-dev', 'autoconf2.13',
+ 'libunwind-dev', 'llvm-dev']
+DNF_PKGS = ['libtool', 'gcc-c++', 'libXi-devel', 'freetype-devel',
+ 'libunwind-devel', 'mesa-libGL-devel', 'mesa-libEGL-devel',
+ 'glib2-devel', 'libX11-devel', 'libXrandr-devel', 'gperf',
+ 'fontconfig-devel', 'cabextract', 'ttmkfdir', 'expat-devel',
+ 'rpm-build', 'openssl-devel', 'cmake',
+ 'libXcursor-devel', 'libXmu-devel',
+ 'dbus-devel', 'ncurses-devel', 'harfbuzz-devel', 'ccache',
+ 'clang', 'clang-libs', 'llvm', 'autoconf213', 'python3-devel',
+ 'gstreamer1-devel', 'gstreamer1-plugins-base-devel',
+ 'gstreamer1-plugins-bad-free-devel', 'libjpeg-turbo-devel',
+ 'zlib', 'libjpeg']
+XBPS_PKGS = ['libtool', 'gcc', 'libXi-devel', 'freetype-devel',
+ 'libunwind-devel', 'MesaLib-devel', 'glib-devel', 'pkg-config',
+ 'libX11-devel', 'libXrandr-devel', 'gperf', 'bzip2-devel',
+ 'fontconfig-devel', 'cabextract', 'expat-devel', 'cmake',
+ 'cmake', 'libXcursor-devel', 'libXmu-devel', 'dbus-devel',
+ 'ncurses-devel', 'harfbuzz-devel', 'ccache', 'glu-devel',
+ 'clang', 'gstreamer1-devel', 'autoconf213',
+ 'gst-plugins-base1-devel', 'gst-plugins-bad1-devel']
+
+
+class Linux(Base):
+ def __init__(self):
+ (self.distro, self.version) = Linux.get_distro_and_version()
+
+ @staticmethod
+ def get_distro_and_version() -> Tuple[str, str]:
+ distrib = six.ensure_str(distro.name())
+ version = six.ensure_str(distro.version())
+
+ if distrib in ['LinuxMint', 'Linux Mint', 'KDE neon', 'Pop!_OS']:
+ if '.' in version:
+ major, _ = version.split('.', 1)
+ else:
+ major = version
+
+ distrib = 'Ubuntu'
+ if major == '22':
+ version = '22.04'
+ elif major == '21':
+ version = '21.04'
+ elif major == '20':
+ version = '20.04'
+ elif major == '19':
+ version = '18.04'
+ elif major == '18':
+ version = '16.04'
+
+ if distrib.lower() == 'elementary':
+ distrib = 'Ubuntu'
+ if version == '5.0':
+ version = '18.04'
+ elif version[0:3] == '0.4':
+ version = '16.04'
+
+ return (distrib, version)
+
+ def _platform_bootstrap(self, _cache_dir: str, force: bool) -> bool:
+ if self.distro.lower() == 'nixos':
+ print('NixOS does not need bootstrap, it will automatically enter a nix-shell')
+ print('Just run ./mach build')
+ print('')
+ print('You will need to run a nix-shell if you are trying '
+ 'to run any of the built binaries')
+ print('To enter the nix-shell manually use:')
+ print(' $ nix-shell etc/shell.nix')
+ return False
+
+ if self.distro.lower() == 'ubuntu' and self.version > '22.04':
+ print(f"WARNING: unsupported version of {self.distro}: {self.version}")
+
+ # FIXME: Better version checking for these distributions.
+ if self.distro.lower() not in [
+ 'arch linux',
+ 'arch',
+ 'centos linux',
+ 'centos',
+ 'debian gnu/linux',
+ 'fedora linux',
+ 'fedora',
+ 'nixos',
+ 'ubuntu',
+ 'void',
+ ]:
+ raise NotImplementedError("mach bootstrap does not support "
+ f"{self.distro}, please file a bug")
+
+ installed_something = self.install_non_gstreamer_dependencies(force)
+ installed_something |= self._platform_bootstrap_gstreamer(_cache_dir, force)
+ return installed_something
+
+ def install_non_gstreamer_dependencies(self, force: bool) -> bool:
+ install = False
+ pkgs = []
+ if self.distro in ['Ubuntu', 'Debian GNU/Linux']:
+ command = ['apt-get', 'install']
+ pkgs = APT_PKGS
+ if subprocess.call(['dpkg', '-s'] + pkgs,
+ stdout=subprocess.PIPE, stderr=subprocess.PIPE) != 0:
+ install = True
+ elif self.distro in ['CentOS', 'CentOS Linux', 'Fedora', 'Fedora Linux']:
+ installed_pkgs = str(subprocess.check_output(['rpm', '-qa'])).replace('\n', '|')
+ pkgs = DNF_PKGS
+ for pkg in pkgs:
+ command = ['dnf', 'install']
+ if "|{}".format(pkg) not in installed_pkgs:
+ install = True
+ break
+ elif self.distro == 'void':
+ installed_pkgs = str(subprocess.check_output(['xbps-query', '-l']))
+ pkgs = XBPS_PKGS
+ for pkg in pkgs:
+ command = ['xbps-install', '-A']
+ if "ii {}-".format(pkg) not in installed_pkgs:
+ install = force = True
+ break
+
+ if not install:
+ return False
+
+ def run_as_root(command, force=False):
+ if os.geteuid() != 0:
+ command.insert(0, 'sudo')
+ if force:
+ command.append('-y')
+ return subprocess.call(command)
+
+ print("Installing missing dependencies...")
+ if run_as_root(command + pkgs, force) != 0:
+ raise Exception("Installation of dependencies failed.")
+ return True
+
+ def _platform_bootstrap_gstreamer(self, _cache_dir: str, _force: bool) -> bool:
+ if self.is_gstreamer_installed():
+ return False
+
+ gstdir = os.path.join(os.curdir, "support", "linux", "gstreamer")
+ if not os.path.isdir(os.path.join(gstdir, "gst", "lib")):
+ subprocess.check_call(["bash", "gstreamer.sh"], cwd=gstdir)
+ return True
+ return False
diff --git a/python/servo/platform/macos.py b/python/servo/platform/macos.py
new file mode 100644
index 00000000000..6189140cabf
--- /dev/null
+++ b/python/servo/platform/macos.py
@@ -0,0 +1,36 @@
+# Copyright 2023 The Servo Project Developers. See the COPYRIGHT
+# file at the top-level directory of this distribution.
+#
+# Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+# http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+# <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+# option. This file may not be copied, modified, or distributed
+# except according to those terms.
+
+import os
+import subprocess
+
+from .base import Base
+from ..gstreamer import macos_gst_root
+
+
+class MacOS(Base):
+ def __init__(self):
+ pass
+
+ def _platform_is_gstreamer_installed(self) -> bool:
+ # We override homebrew gstreamer if installed and always use pkgconfig
+ # from official gstreamer framework.
+ try:
+ gst_root = macos_gst_root()
+ env = os.environ.copy()
+ env["PATH"] = os.path.join(gst_root, "bin")
+ env["PKG_CONFIG_PATH"] = os.path.join(gst_root, "lib", "pkgconfig")
+ has_gst = subprocess.call(
+ ["pkg-config", "--atleast-version=1.21", "gstreamer-1.0"],
+ stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=env) == 0
+ gst_lib_dir = subprocess.check_output(
+ ["pkg-config", "--variable=libdir", "gstreamer-1.0"], env=env)
+ return has_gst and gst_lib_dir.startswith(bytes(gst_root, 'utf-8'))
+ except FileNotFoundError:
+ return False
diff --git a/python/servo/platform/windows.py b/python/servo/platform/windows.py
new file mode 100644
index 00000000000..cea8de5a5dd
--- /dev/null
+++ b/python/servo/platform/windows.py
@@ -0,0 +1,98 @@
+# Copyright 2023 The Servo Project Developers. See the COPYRIGHT
+# file at the top-level directory of this distribution.
+#
+# Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+# http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+# <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+# option. This file may not be copied, modified, or distributed
+# except according to those terms.
+
+import os
+import shutil
+import subprocess
+import urllib
+import zipfile
+
+from distutils.version import LooseVersion
+
+import six
+from .base import Base
+from ..util import extract, download_file
+
+DEPS_URL = "https://github.com/servo/servo-build-deps/releases/download/msvc-deps/"
+DEPENDENCIES = {
+ "cmake": "3.14.3",
+ "llvm": "15.0.5",
+ "moztools": "3.2",
+ "ninja": "1.7.1",
+ "nuget": "08-08-2019",
+ "openssl": "111.3.0+1.1.1c-vs2017-2019-09-18",
+ "gstreamer-uwp": "1.16.0.5",
+ "openxr-loader-uwp": "1.0",
+}
+
+
+class Windows(Base):
+ def __init__(self):
+ pass
+
+ @staticmethod
+ def cmake_already_installed(required_version: str) -> bool:
+ cmake_path = shutil.which("cmake")
+ if not cmake_path:
+ return False
+
+ output = subprocess.check_output([cmake_path, "--version"])
+ cmake_version_output = six.ensure_str(output).splitlines()[0]
+ installed_version = cmake_version_output.replace("cmake version ", "")
+ return LooseVersion(installed_version) >= LooseVersion(required_version)
+
+ @classmethod
+ def prepare_file(cls, deps_dir: str, zip_path: str, full_spec: str):
+ if not os.path.isfile(zip_path):
+ zip_url = "{}{}.zip".format(DEPS_URL, urllib.parse.quote(full_spec))
+ download_file(full_spec, zip_url, zip_path)
+
+ print("Extracting {}...".format(full_spec), end='')
+ try:
+ extract(zip_path, deps_dir)
+ except zipfile.BadZipfile:
+ print("\nError: %s.zip is not a valid zip file, redownload..." % full_spec)
+ os.remove(zip_path)
+ cls.prepare_file(deps_dir, zip_path, full_spec)
+ else:
+ print("done")
+
+ def _platform_bootstrap(self, cache_dir: str, _force: bool = False) -> bool:
+ deps_dir = os.path.join(cache_dir, "msvc-dependencies")
+
+ def get_package_dir(package, version) -> str:
+ return os.path.join(deps_dir, package, version)
+
+ to_install = {}
+ for (package, version) in DEPENDENCIES.items():
+ # Don't install CMake if it already exists in PATH
+ if package == "cmake" and self.cmake_already_installed(version):
+ continue
+
+ if not os.path.isdir(get_package_dir(package, version)):
+ to_install[package] = version
+
+ if not to_install:
+ return False
+
+ print("Installing missing MSVC dependencies...")
+ for (package, version) in to_install.items():
+ full_spec = '{}-{}'.format(package, version)
+
+ package_dir = get_package_dir(package, version)
+ parent_dir = os.path.dirname(package_dir)
+ if not os.path.isdir(parent_dir):
+ os.makedirs(parent_dir)
+
+ self.prepare_file(deps_dir, package_dir + ".zip", full_spec)
+
+ extracted_path = os.path.join(deps_dir, full_spec)
+ os.rename(extracted_path, package_dir)
+
+ return True