The Servo Browser Engine
Servo is a prototype web browser engine written in the Rust language. It is currently developed on 64-bit macOS, 64-bit Linux, 64-bit Windows, and Android.
HACKING_QUICKSTART.mdfor help getting started.
Visit the Servo Project page for news and guides.
Building servo requires rustup, version 1.8.0 or more recent. If you have an older version, run
rustup self update.
To install on other systems, run:
curl https://sh.rustup.rs -sSf | sh
This will also download the current stable version of Rust, which Servo won’t use. To skip that step, run instead:
curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain none
See also Other installation methods
Xcode version 10.2 or above is recommended.
NOTE: run these steps after you've cloned the project locally.
cd servo brew bundle install --file=etc/taskcluster/macos/Brewfile brew bundle install --file=etc/taskcluster/macos/Brewfile-build pip install virtualenv
sudo apt install python-virtualenv python-pip ./mach bootstrap
./mach bootstrapdoesn't work, file a bug, and, run the commands below:
sudo apt install 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 llvm-dev
Additionally, you'll need a local copy of GStreamer with a version later than 16.2. You can place it in
support/linux/gstreamer/gst, or run
./mach bootstrap-gstreamerto set it up. On Ubuntu 20.04LTS, you can use the system GStreamer if you install the necessary packages:
sh sudo apt install gstreamer1.0-nice gstreamer1.0-plugins-bad
If you are using Ubuntu 16.04 or Linux Mint 18.* run
export HARFBUZZ_SYS_NO_PKG_CONFIG=1before building to avoid an error with harfbuzz.
If you get an undefined symbol error on
gir1.2-gst-plugins-bad-1.0and all old versions of clang, see #22016
sudo dnf install python3 python3-virtualenv python3-pip python3-devel python3 ./mach bootstrap
python3 ./mach bootstrapdoesn't work, file a bug, and, run the commands below:
sudo dnf install curl libtool gcc-c++ libXi-devel libunwind-devel \ freetype-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 libX11-devel libXcursor-devel \ libXmu-devel dbus-devel ncurses-devel harfbuzz-devel \ ccache clang clang-libs python3-devel gstreamer1-devel \ gstreamer1-plugins-base-devel gstreamer1-plugins-bad-free-devel autoconf213
sudo yum install python-virtualenv python-pip ./mach bootstrap
./mach bootstrapdoesn't work, file a bug, and, run the commands below:
sudo yum install curl libtool gcc-c++ libXi-devel freetype-devel \ mesa-libGL-devel mesa-libEGL-devel glib2-devel libX11-devel libXrandr-devel \ gperf fontconfig-devel cabextract ttmkfdir python expat-devel rpm-build \ openssl-devel cmake3 libXcursor-devel libXmu-devel \ dbus-devel ncurses-devel python34 harfbuzz-devel \ ccache clang clang-libs llvm-toolset-7
scl enable devtoolset-7 llvm-toolset-7 bash
with the following environmental variables set:
export CMAKE=cmake3 export LIBCLANG_PATH=/opt/rh/llvm-toolset-7/root/usr/lib64
sudo zypper install libX11-devel libexpat-devel Mesa-libEGL-devel Mesa-libGL-devel cabextract cmake \ dbus-1-devel fontconfig-devel freetype-devel gcc-c++ git glib2-devel gperf \ harfbuzz-devel libXcursor-devel libXi-devel libXmu-devel libXrandr-devel libopenssl-devel \ python-pip python-virtualenv rpm-build ccache llvm-clang libclang autoconf213 gstreamer-devel \ gstreamer-plugins-base-devel gstreamer-plugins-bad-devel
sudo pacman -S --needed base-devel git python2 python2-virtualenv python2-pip mesa cmake libxmu \ pkg-config ttf-fira-sans harfbuzz ccache llvm clang autoconf2.13 gstreamer gstreamer-vaapi
sudo emerge net-misc/curl \ media-libs/freetype media-libs/mesa dev-util/gperf \ dev-python/virtualenv dev-python/pip dev-libs/openssl \ media-libs/harfbuzz dev-util/ccache sys-libs/libunwind \ x11-libs/libXmu x11-base/xorg-server sys-devel/clang \ media-libs/gstreamer media-libs/gst-plugins-bad media-libs/gst-plugins-base
With the following environment variable set:
sh export LIBCLANG_PATH=$(llvm-config --prefix)/lib64
You should change the installation to install the "Add python.exe to Path" feature.
You will also need to set the
PYTHON2environment variable, e.g., to 'C:\Python27\python.exe' by doing:
setx PYTHON2 "C:\Python27\python.exe" /m
You will also need to set the
PYTHON3environment variable, e.g., to 'C:\Python37\python.exe' by doing:
setx PYTHON3 "C:\Python37\python.exe" /mThe
/mwill set it system-wide for all future command windows.
In a normal Windows Shell (cmd.exe or "Command Prompt" from the start menu), do:
pip install virtualenvIf this does not work, you may need to reboot for the changed PATH settings (by the python installer) to take effect.
.msifiles for your platform from the GStreamer website and install them. The currently recommended version is 1.16.0. i.e.:
Note that the MinGW binaries will not work, so make sure that you install the MSVC the ones.
Note that you should ensure that all components are installed from gstreamer, as we require many of the optional libraries that are not installed by default.
Install Git for Windows (https://git-scm.com/download/win). DO allow it to add git.exe to the PATH (default settings for the installer are fine).
Install Visual Studio Community 2017 (https://www.visualstudio.com/vs/community/). You MUST add "Visual C++" to the list of installed components as well as the "Windows Universal C runtime." They are not on by default. Visual Studio 2017 MUST installed to the default location or mach.bat will not find it.
Note that version is hard to download online and is easier to install via Chocolatey with: ``` choco install -y visualstudio2017community --package-parameters="'--add Microsoft.VisualStudio.Component.Git'" Update-SessionEnvironment #refreshing env due to Git install
choco install -y visualstudio2017-workload-nativedesktop ```
You may experience much faster builds on Windows by following these steps. (Related Rust issue: https://github.com/rust-lang/rust/issues/37543)
%USERPROFILE%\.cargo\config). You may need to change the triple to match your environment.
[target.x86_64-pc-windows-msvc] linker = "lld-link.exe"
If you encountered errors with the environment above, do the following for a workaround: 1. Download and install Build Tools for Visual Studio 2017 2. Installpython2.7 x86-x64andvirtualenv3. Runmach.bat build -d.
If you have troubles withx64 typeprompt asmach.batset by default: 1. You may need to choose and launch the type manually, such asx86_x64 Cross Tools Command Prompt for VS 2017in the Windows menu.) 2.cd to/the/path/servo3.python mach build -d
If you got the errorCannot run mach in a path on a case-sensitive file system on Windows: 1. Open Command Prompt or PowerShell as administrator. 2. Disable case-sensitive for servo path,fsutil.exe file SetCaseSensitiveInfo X:\path\to\servo disable
If you got the errorDLL fileapi-ms-win-crt-runtime-l1-1-0.dllnot found!then set theWindowsSdkDirenvironment variable to an appropriateWindows Kitdirectory containingRedist\ucrt\DLLs\x64\api-ms-win-crt-runtime-l1-1-0.dll, for exampleC:\Program Files (x86)\Windows Kits\10.
If you get the errorthread 'main' panicked at 'Unable to find libclang: "couldn\'t find any valid shared libraries matching: [\'clang.dll\', \'libclang.dll\'], set theLIBCLANGPATHenvironment variable to a path where one of these files can be found (invalid: ... invalid DLL (64-bit))])"'thenrustupmay have installed the 32-bit default target rather than the 64-bit one. You can find the configuration withrustup show, and set the default with `rustup set default-host x8664-pc-windows-msvc`.
./mach bootstrap-android --buildto get Android-specific tools. See wiki for details.
Servo is built with Cargo, the Rust package manager. We also use Mozilla's Mach tools to orchestrate the build and other tasks.
To build Servo in development mode. This is useful for development, but the resulting binary is very slow.
git clone https://github.com/servo/servo cd servo ./mach build --dev ./mach run tests/html/about-mozilla.html
Or on Windows MSVC, in a normal Command Prompt (cmd.exe):
cmd git clone https://github.com/servo/servo cd servo mach.bat build --dev
For benchmarking, performance testing, or real-world use, add the
--releaseflag to create an optimized build:
./mach build --release ./mach run --release tests/html/about-mozilla.html
mach buildwill build both
libsimpleservo. To make compilation a bit faster, it's possible to only compile the servo binary:
./mach build --dev -p servo.
If you’re making changes to one crate that cause build errors in another crate, consider this instead of a full build:
It will run
cargo check, which runs the analysis phase of the compiler (and so shows build errors if any) but skips the code generation phase. This can be a lot faster than a full build, though of course it doesn’t produce a binary you can run.
For ARM (
armv7-linux-androideabi, most phones):
./mach build --release --android ./mach package --release --android
For x86 (typically for the emulator):
./mach build --release --target i686-linux-android ./mach package --release --target i686-linux-android
Run Servo with the command:
./servo [url] [arguments] # if you run with nightly build ./mach run [url] [arguments] # if you run with mach
./mach run https://www.google.com
-p INTERVALturns on the profiler and dumps info to the console every
-s SIZEsets the tile size for painting; defaults to 512
-zdisables all graphical output; useful for running JS / layout tests
-Z helpdisplays useful output to debug servo
Lopens URL prompt (
Rreloads current page (
-zooms out (
=zooms in (
left arrowgoes backwards in the history (
left arrowon Mac)
right arrowgoes forwards in the history (
right arrowon Mac)
Qexits Servo (
There are lots of mach commands you can use. You can list them with
The generated documentation can be found on https://doc.servo.org/servo/index.html