gecko-dev/servo
Yati Sagade cda0c94d8c servo: Merge #19256 - Paint worklets: Implement timeout for worklet painter threads (from yati-sagade:master); r=asajeffrey
When a paint worklet thread takes too long, we would like to move on,
since we have a ~16ms budget for rendering at 60fps. At the moment, there
is no provision in the paintworklet spec to signal such timeouts to the
developer. ajeffrey opened an [issue][1] for this, but it got punted to
v2 of the spec. Hence we are silently timing out unresponsive paint
scripts.

The timeout value is chosen to be 10ms by default, and can be overridden
by setting the SERVO_PAINT_WORKLET_TIMEOUT_MS environment variable.

In the absence of such a timeout, the reftest in this commit would fail
by timing out the testrunner itself, since the paint script never
returns. From my discussions with ajeffrey, this should do until we spec
out a way to signal timeouts to the script developer.

This fixes #17370.

[1]: https://github.com/w3c/css-houdini-drafts/issues/507

<!-- Please describe your changes on the following line: -->

---
<!-- Thank you for contributing to Servo! Please replace each `[ ]` by `[X]` when the step is complete, and replace `__` with appropriate data: -->
- [x] `./mach build -d` does not report any errors
- [x] `./mach test-tidy` does not report any errors
- [x] These changes fix #__ (github issue number if applicable).

<!-- Either: -->
- [x] There are tests for these changes OR
- [ ] These changes do not require tests because _____

<!-- Also, please make sure that "Allow edits from maintainers" checkbox is checked, so that we can help you if you get stuck somewhere along the way.-->

<!-- Pull requests that do not address these steps are welcome, but they will require additional verification as part of the review process. -->

Source-Repo: https://github.com/servo/servo
Source-Revision: 54f8cc37c5a7874607128e3518fd0982f7065565

--HG--
extra : subtree_source : https%3A//hg.mozilla.org/projects/converted-servo-linear
extra : subtree_revision : 0234a7fd5437d1c2a9c0424b9e2bb51d309a4490
2017-12-22 04:50:16 -06:00
..
.cargo servo: Merge #19017 - Print the full path for errors occurring in the servo crate (from tigercosmos:test); r=jdm 2017-11-03 09:05:17 -05:00
components servo: Merge #19256 - Paint worklets: Implement timeout for worklet painter threads (from yati-sagade:master); r=asajeffrey 2017-12-22 04:50:16 -06:00
docs servo: Merge #19116 - Fix dead link in COMMAND_LINE_ARGS.md (from servo:cla-doc-link); r=KiChjang 2017-11-04 15:58:27 -05:00
etc servo: Merge #19612 - deny warnings (from tigercosmos:o1); r=jdm 2017-12-21 13:57:04 -06:00
ports servo: Merge #19612 - deny warnings (from tigercosmos:o1); r=jdm 2017-12-21 13:57:04 -06:00
python servo: Merge #19539 - mach: Fix cargo-geckolib check / cargo-geckolib build after #19476 (from emilio:cargo-geckolib); r=SimonSapin 2017-12-13 20:26:43 -06:00
resources servo: Merge #18676 - Continue http cache work (from gterzian:continue_http_cache_work); r=jdm 2017-11-20 18:22:06 -06:00
support servo: Merge #18967 - Bump bitflags to 1.0 (from Eijebong:bitflags2.0); r=mbrubeck 2017-10-30 18:25:45 -05:00
tests servo: Merge #19589 - remove unused `Auto` in test of serialization (from tigercosmos:e1); r=emilio 2017-12-17 11:51:10 -06:00
.gitattributes
.gitignore servo: Merge #19232 - Update web-platform-tests (from jdm:updatewpt8); r=jdm 2017-11-15 23:53:19 -06:00
.hgignore
.mailmap
.taskcluster.yml servo: Merge #17580 - Add rudimentary .taskcluster.yml (from edunham:taskcluster); r=aneeshusa 2017-12-14 14:23:58 -06:00
.travis.yml servo: Merge #19612 - deny warnings (from tigercosmos:o1); r=jdm 2017-12-21 13:57:04 -06:00
CLOBBER
CONTRIBUTING.md
Cargo.lock servo: Merge #19611 - Bump mozjs to 0.1.9 (from Xanewok:bump-mozjs); r=jdm 2017-12-20 12:09:20 -06:00
Cargo.toml servo: Merge #19590 - Use [patch] instead of [replace] (from servo:patch); r=SimonSapin 2017-12-17 15:18:05 -06:00
Info.plist
LICENSE
PULL_REQUEST_TEMPLATE.md
README.md servo: Merge #19545 - Fix and document build on CentOS 7.4 (from marmistrz:bump-gecko-media); r=jdm 2017-12-18 11:19:40 -06:00
appveyor.yml servo: Merge #19612 - deny warnings (from tigercosmos:o1); r=jdm 2017-12-21 13:57:04 -06:00
dependencyci.yml servo: Merge #18903 - Don't report smallbitvec as an error (from servo:jdm-patch-2); r=emilio 2017-10-16 20:37:02 -05:00
mach
mach.bat servo: Merge #19324 - Get back to working dir after vcvarsall.bat (from drewler:fix_matchbat); r=jdm 2017-11-21 17:27:34 -06:00
moz.build servo: Merge #19041 - Bug 1411583 - servo directory in-tree has no BUGZILLA_COMPONENTS info… (from jmaher:mozbuild); r=jdm 2017-10-28 14:13:25 -05:00
rust-stable-version servo: Merge #19532 - Use Rust 1.22.1 for geckolib (from mbrubeck:rustup); r=SimonSapin 2017-12-09 01:14:02 -06:00
rust-toolchain servo: Merge #19574 - Downgrade to rustc nightly-2017-11-14 (from asajeffrey:rustdown-2017-11-14); r=glennw 2017-12-18 13:59:23 -06:00
rustfmt.toml
servo-tidy.toml servo: Merge #19559 - implement valid week string (from tigercosmos:t1); r=KiChjang 2017-12-17 03:50:33 -06:00
servobuild.example servo: Merge #19213 - Stop using "alternate" rustc builds (from servo:nightly); r=nox 2017-11-14 02:18:20 -06:00

README.md

The Servo Parallel Browser Engine Project

Linux Build Status Windows Build Status Changelog #228

Servo is a prototype web browser engine written in the Rust language. It is currently developed on 64-bit OS X, 64-bit Linux, 64-bit Windows, and Android.

Servo welcomes contribution from everyone. See CONTRIBUTING.md and HACKING_QUICKSTART.md for help getting started.

Visit the Servo Project page for news and guides.

Setting up your environment

Please select your operating system:

OS X

On OS X (homebrew)

brew install automake pkg-config python cmake yasm
pip install virtualenv

On OS X (MacPorts)

sudo port install python27 py27-virtualenv cmake yasm

On OS X >= 10.11 (El Capitan), you also have to install OpenSSL

brew install openssl

export OPENSSL_INCLUDE_DIR="$(brew --prefix openssl)/include"
export OPENSSL_LIB_DIR="$(brew --prefix openssl)/lib"

./mach build ...

If you've already partially compiled servo but forgot to do this step, run ./mach clean, set the shell variables, and recompile.

On Debian-based Linuxes

sudo apt install git curl freeglut3-dev autoconf libx11-dev \
    libfreetype6-dev libgl1-mesa-dri libglib2.0-dev xorg-dev \
    gperf g++ build-essential cmake virtualenv python-pip \
    libssl1.0-dev libbz2-dev libosmesa6-dev libxmu6 libxmu-dev \
    libglu1-mesa-dev libgles2-mesa-dev libegl1-mesa-dev \
    pulseaudio dbus-x11 libavcodec-dev libavformat-dev \
    libavutil-dev libswresample-dev  libswscale-dev libdbus-1-dev \
    libpulse-dev clang

If you using a version prior to Ubuntu 17.04 or Debian Sid, replace libssl1.0-dev with libssl-dev.

If you are on Ubuntu 14.04 and encountered errors on installing these dependencies involving libcheese, see #6158 for a workaround.

If virtualenv does not exist, try python-virtualenv.

On Fedora

sudo dnf install curl freeglut-devel 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 python-virtualenv python-pip expat-devel \
    rpm-build openssl-devel cmake bzip2-devel libXcursor-devel libXmu-devel mesa-libOSMesa-devel \
    dbus-devel ncurses-devel pulseaudio-libs-devel clang clang-libs

On CentOS

sudo yum install curl freeglut-devel 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 python-virtualenv python-pip expat-devel \
    rpm-build openssl-devel cmake3 bzip2-devel libXcursor-devel libXmu-devel mesa-libOSMesa-devel \
    dbus-devel ncurses-devel python34 pulseaudio-libs-devel clang clang-libs llvm-toolset-7

Build inside llvm-toolset and devtoolset:

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

On openSUSE Linux

sudo zypper install libX11-devel libexpat-devel libbz2-devel Mesa-libEGL-devel Mesa-libGL-devel cabextract cmake \
    dbus-1-devel fontconfig-devel freetype-devel gcc-c++ git glib2-devel gperf \
    harfbuzz-devel libOSMesa-devel libXcursor-devel libXi-devel libXmu-devel libXrandr-devel libopenssl-devel \
    python-pip python-virtualenv rpm-build glu-devel llvm-clang libclang

On Arch Linux

sudo pacman -S --needed base-devel git python2 python2-virtualenv python2-pip mesa cmake bzip2 libxmu glu pkg-config

On Gentoo Linux

sudo emerge net-misc/curl media-libs/freeglut \
    media-libs/freetype media-libs/mesa dev-util/gperf \
    dev-python/virtualenv dev-python/pip dev-libs/openssl \
    x11-libs/libXmu media-libs/glu x11-base/xorg-server

On Windows (MSVC)

  1. Install Python for Windows (https://www.python.org/downloads/release/python-2714/). The Windows x86-64 MSI installer is fine. You should change the installation to install the "Add python.exe to Path" feature.

  2. Install virtualenv.

In a normal Windows Shell (cmd.exe or "Command Prompt" from the start menu), do:

pip install virtualenv

If this does not work, you may need to reboot for the changed PATH settings (by the python installer) to take effect.

  1. 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).

  2. Install Visual Studio Community 2017 (https://www.visualstudio.com/vs/community/). You MUST add "Visual C++" to the list of installed components. It is not on by default. Visual Studio 2017 MUST installed to the default location or mach.bat will not find it.

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. Install python2.7 x86-x64 and virtualenv
  3. Run mach.bat build -d.

If you have troubles with x64 type prompt as mach.bat set by default:

  1. you may need to choose and launch the type manually, such as x86_x64 Cross Tools Command Prompt for VS 2017 in the Windows menu.)
  2. cd to/the/path/servo
  3. python mach build -d

Cross-compilation for Android

Pre-installed Android tools are needed. See wiki for details

The Rust compiler

Servo's build system automatically downloads a Rust compiler to build itself. This is normally a specific revision of Rust upstream, but sometimes has a backported patch or two. If you'd like to know which nightly build of Rust we use, see rust-toolchain.

Building

Servo is built with Cargo, the Rust package manager. We also use Mozilla's Mach tools to orchestrate the build and other tasks.

Normal build

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):

git clone https://github.com/servo/servo
cd servo
mach.bat build --dev

For benchmarking, performance testing, or real-world use, add the --release flag to create an optimized build:

./mach build --release
./mach run --release tests/html/about-mozilla.html

Checking for build errors, without building

If youre making changes to one crate that cause build errors in another crate, consider this instead of a full build:

./mach check

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 doesnt produce a binary you can run.

Building for Android target

git clone https://github.com/servo/servo
cd servo

export ANDROID_SDK="/path/to/sdk"
export ANDROID_NDK="/path/to/ndk"
export ANDROID_TOOLCHAIN="/path/to/toolchain"
export PATH="$PATH:/path/to/toolchain/bin"

./mach build --release --android
./mach package --release --android

Rather than setting the ANDROID_* environment variables every time, you can also create a .servobuild file and then edit it to contain the correct paths to the Android SDK/NDK tools:

cp servobuild.example .servobuild
# edit .servobuild

Running

Use ./mach run [url] to run Servo. Like so,

./mach run https://www.google.com

Also, don't miss the info on the browserhtml page on how to run the Browser.html full tech demo (it provides a more browser-like experience than just browsing a single URL with servo).

Commandline Arguments

  • -p INTERVAL turns on the profiler and dumps info to the console every INTERVAL seconds
  • -s SIZE sets the tile size for painting; defaults to 512
  • -z disables all graphical output; useful for running JS / layout tests
  • -Z help displays useful output to debug servo

Keyboard Shortcuts

  • Ctrl+- zooms out
  • Ctrl+= zooms in
  • Alt+left arrow goes backwards in the history
  • Alt+right arrow goes forwards in the history
  • Esc exits servo

Developing

There are lots of mach commands you can use. You can list them with ./mach --help.

The generated documentation can be found on http://doc.servo.org/servo/index.html