aboutsummaryrefslogtreecommitdiffstats
path: root/python/servo/platform/linux.py
blob: 8ff35b25bdfce499b1fe528d118e7a7fd65810ae (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
# 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 distro
import os
import subprocess
import shutil
from typing import Optional, Tuple

from .base import Base
from .build_target import BuildTarget

# Please keep these in sync with the packages in the book, using the instructions below
# https://book.servo.org/hacking/setting-up-your-environment.html

# https://packages.debian.org
# https://packages.ubuntu.com
# 1. open devtools
# 2. paste in the whole APT_PKGS = [...]
# 3. copy(`sudo apt install ${APT_PKGS.join(" ")}`)
# 4. paste into https://github.com/servo/book/edit/main/src/hacking/setting-up-your-environment.md
APT_PKGS = [
    'build-essential', 'ccache', 'clang', 'cmake', 'curl', 'g++', 'git',
    'gperf', 'libdbus-1-dev', 'libfreetype6-dev', 'libgl1-mesa-dri',
    'libgles2-mesa-dev', 'libglib2.0-dev',
    'gstreamer1.0-plugins-good', 'libgstreamer-plugins-good1.0-dev',
    'gstreamer1.0-plugins-bad', 'libgstreamer-plugins-bad1.0-dev',
    'gstreamer1.0-plugins-ugly',
    "gstreamer1.0-plugins-base", 'libgstreamer-plugins-base1.0-dev',
    'gstreamer1.0-libav',
    'libgstrtspserver-1.0-dev',
    'gstreamer1.0-tools',
    'libges-1.0-dev',
    'libharfbuzz-dev', 'liblzma-dev', 'libudev-dev', 'libunwind-dev',
    'libvulkan1', 'libx11-dev', 'libxcb-render0-dev', 'libxcb-shape0-dev',
    'libxcb-xfixes0-dev', 'libxmu-dev', 'libxmu6', 'libegl1-mesa-dev',
    'llvm-dev', 'm4', 'xorg-dev', 'libxkbcommon0', "libxkbcommon-x11-0",
    'tshark',
]

# https://packages.fedoraproject.org
# 1. open devtools
# 2. paste in the whole DNF_PKGS = [...]
# 3. copy(`sudo dnf install ${DNF_PKGS.join(" ")}`)
# 4. paste into https://github.com/servo/book/edit/main/src/hacking/setting-up-your-environment.md
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', 'cmake', 'libXcursor-devel', 'libXmu-devel',
            'dbus-devel', 'ncurses-devel', 'harfbuzz-devel', 'ccache',
            'clang', 'clang-libs', 'llvm', 'python3-devel',
            'gstreamer1-devel', 'gstreamer1-plugins-base-devel',
            'gstreamer1-plugins-good', 'gstreamer1-plugins-bad-free-devel',
            'gstreamer1-plugins-ugly-free', 'libjpeg-turbo-devel',
            'zlib-ng', 'libjpeg-turbo', 'vulkan-loader', 'libxkbcommon',
            'libxkbcommon-x11', 'wireshark-cli']

# https://voidlinux.org/packages/
# 1. open devtools
# 2. paste in the whole XBPS_PKGS = [...]
# 3. copy(`sudo xbps-install ${XBPS_PKGS.join(" ")}`)
# 4. paste into https://github.com/servo/book/edit/main/src/hacking/setting-up-your-environment.md
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', 'gst-plugins-base1-devel',
             'gst-plugins-good1', 'gst-plugins-bad1-devel',
             'gst-plugins-ugly1', 'vulkan-loader', 'libxkbcommon',
             'libxkbcommon-x11']

GSTREAMER_URL = \
    "https://github.com/servo/servo-build-deps/releases/download/linux/gstreamer-1.16-x86_64-linux-gnu.20190515.tar.gz"


class Linux(Base):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.is_linux = True
        (self.distro, self.version) = Linux.get_distro_and_version()

    @staticmethod
    def get_distro_and_version() -> Tuple[str, str]:
        distrib = distro.name()
        version = distro.version()

        if distrib in ['LinuxMint', 'Linux Mint', 'KDE neon', 'Pop!_OS', 'TUXEDO 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, 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')
            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',
            'artix',
            'endeavouros',
            'centos linux',
            'centos',
            'debian gnu/linux',
            'raspbian gnu/linux',
            'fedora linux',
            'fedora',
            'nixos',
            'ubuntu',
            'void',
            'fedora linux asahi remix'
        ]:
            print(f"mach bootstrap does not support {self.distro}."
                  " You may be able to install dependencies manually."
                  " See https://github.com/servo/servo/wiki/Building.")
            input("Press Enter to continue...")
            return False

        installed_something = self.install_non_gstreamer_dependencies(force)
        return installed_something

    def install_non_gstreamer_dependencies(self, force: bool) -> bool:
        install = False
        pkgs = []
        if self.distro in ['Ubuntu', 'Debian GNU/Linux', 'Raspbian GNU/Linux']:
            command = ['apt-get', 'install', "-m"]
            pkgs = APT_PKGS

            # Skip 'clang' if 'clang' binary already exists.
            result = subprocess.run(['which', 'clang'], capture_output=True)
            if result and result.returncode == 0:
                pkgs.remove('clang')

            # Try to filter out unknown packages from the list. This is important for Debian
            # as it does not ship all of the packages we want.
            installable = subprocess.check_output(['apt-cache', '--generate', 'pkgnames'])
            if installable:
                installable = installable.decode("ascii").splitlines()
                pkgs = list(filter(lambda pkg: pkg in installable, pkgs))

            if subprocess.call(['dpkg', '-s'] + pkgs, shell=True,
                               stdout=subprocess.PIPE, stderr=subprocess.PIPE) != 0:
                install = True
        elif self.distro in ['CentOS', 'CentOS Linux', 'Fedora', 'Fedora Linux', 'Fedora Linux Asahi Remix']:
            command = ['dnf', 'install']
            installed_pkgs: [str] = (
                subprocess.check_output(['rpm', '--query', '--all', '--queryformat', '%{NAME}\n'],
                                        encoding='utf-8')
                .split('\n'))
            pkgs = DNF_PKGS
            for pkg in pkgs:
                if 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 check_sudo():
            if os.geteuid() != 0:
                if shutil.which('sudo') is None:
                    return False
            return True

        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 not check_sudo():
            print("'sudo' command not found."
                  " You may be able to install dependencies manually."
                  " See https://github.com/servo/servo/wiki/Building.")
            input("Press Enter to continue...")
            return False

        if run_as_root(command + pkgs, force) != 0:
            raise EnvironmentError("Installation of dependencies failed.")
        return True

    def gstreamer_root(self, _target: BuildTarget) -> Optional[str]:
        return None

    def _platform_bootstrap_gstreamer(self, _target: BuildTarget, _force: bool) -> bool:
        raise EnvironmentError(
            "Bootstrapping GStreamer on Linux is not supported. "
            + "Please install it using your distribution package manager.")