mirror of
https://github.com/servo/servo.git
synced 2025-06-06 16:45:39 +00:00
The Servo Browser Engine
Background: > JavaScript strings are potentially ill-formed UTF-16 (arbitrary > Vec<u16>) and can contain unpaired surrogates. Rust’s String type is > well-formed UTF-8 and can not contain any surrogate. Surrogates are > never emitted when decoding bytes from the network, but they can sneak > in through document.write, the Element.innerHtml setter, or other DOM > APIs. In 2015, Servo launched an experiment to see if unpaired surrogates cropped up in page content. That experiment caused Servo to panic if unpaired surrogates were encountered with a request to report the page to bug #6564. During that time several pages were reported with unpaired surrogates, causing Servo to panic. In addition, when running the WPT tests Servo will never panic due to the `-Z replace-surrogates` option being passed by the test driver. Motivation: After this 10 year experiment, it's clear that unpaired surrogates are a real concern in page content. Several reports were filed of Servo panicking after encountering them in real world pages. A complete fix for this issue would be to somehow maintain unpaired surrogates in the DOM, but that is a much larger task than simply emitting U+FFD instead of an unpaired surrogate. Since it is clear that this kind of content exists, it is better for Servo to try its best to handle the content rather than crash as production browsers should not crash due to user content when possible. In this change, I modify Servo to always replace unpaired surrogates. It would have been ideal to only crash when debug assertions are enabled, but debug assertions are enabled by default in release mode -- so this wouldn't be effective for WPT tests. Signed-off-by: Martin Robinson <mrobinson@igalia.com> |
||
---|---|---|
.cargo | ||
.github | ||
.vscode | ||
components | ||
docs | ||
etc | ||
ports/servoshell | ||
python | ||
resources | ||
support | ||
tests | ||
third_party | ||
.clang-format | ||
.flake8 | ||
.gitattributes | ||
.gitignore | ||
.mailmap | ||
.python-version | ||
Cargo.lock | ||
Cargo.toml | ||
CLOBBER | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
deny.toml | ||
Info.plist | ||
LICENSE | ||
mach | ||
mach.bat | ||
PULL_REQUEST_TEMPLATE.md | ||
README.md | ||
rust-toolchain.toml | ||
rustfmt.toml | ||
SECURITY.md | ||
servo-tidy.toml | ||
servobuild.example | ||
shell.nix | ||
taplo.toml |
The Servo Parallel Browser Engine Project
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, 64-bit OpenHarmony, and Android.
Servo welcomes contribution from everyone. Check out The Servo Book to get started, or go to servo.org for news and guides.
Getting started
For more detailed build instructions, see the Servo book under Setting up your environment, Building Servo, Building for Android and Building for OpenHarmony.
macOS
- Download and install Xcode and
brew
. - Install
uv
:curl -LsSf https://astral.sh/uv/install.sh | sh
- Install
rustup
:curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
- Restart your shell to make sure
cargo
is available - Install the other dependencies:
./mach bootstrap
- Build servoshell:
./mach build
Linux
- Install
curl
:- Arch:
sudo pacman -S --needed curl
- Debian, Ubuntu:
sudo apt install curl
- Fedora:
sudo dnf install curl
- Gentoo:
sudo emerge net-misc/curl
- Arch:
- Install
uv
:curl -LsSf https://astral.sh/uv/install.sh | sh
- Install
rustup
:curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
- Restart your shell to make sure
cargo
is available - Install the other dependencies:
./mach bootstrap
- Build servoshell:
./mach build
Windows
- Download
uv
,choco
, andrustup
- Be sure to select Quick install via the Visual Studio Community installer
- In the Visual Studio Installer, ensure the following components are installed:
- Windows 10 SDK (10.0.19041.0) (
Microsoft.VisualStudio.Component.Windows10SDK.19041
) - MSVC v143 - VS 2022 C++ x64/x86 build tools (Latest) (
Microsoft.VisualStudio.Component.VC.Tools.x86.x64
) - C++ ATL for latest v143 build tools (x86 & x64) (
Microsoft.VisualStudio.Component.VC.ATL
) - C++ MFC for latest v143 build tools (x86 & x64) (
Microsoft.VisualStudio.Component.VC.ATLMFC
)
- Windows 10 SDK (10.0.19041.0) (
- Restart your shell to make sure
cargo
is available - Install the other dependencies:
.\mach bootstrap
- Build servoshell:
.\mach build
Android
- Ensure that the following environment variables are set:
ANDROID_SDK_ROOT
ANDROID_NDK_ROOT
:$ANDROID_SDK_ROOT/ndk/26.2.11394342/
ANDROID_SDK_ROOT
can be any directory (such as~/android-sdk
). All of the Android build dependencies will be installed there.
- Install the latest version of the Android command-line
tools to
$ANDROID_SDK_ROOT/cmdline-tools/latest
. - Run the following command to install the necessary components:
sudo $ANDROID_SDK_ROOT/cmdline-tools/latest/bin/sdkmanager --install \ "build-tools;34.0.0" \ "emulator" \ "ndk;26.2.11394342" \ "platform-tools" \ "platforms;android-33" \ "system-images;android-33;google_apis;x86_64"
- Follow the instructions above for the platform you are building on
OpenHarmony
- Follow the instructions above for the platform you are building on to prepare the environment.
- Depending on the target distribution (e.g.
HarmonyOS NEXT
vs pureOpenHarmony
) the build configuration will differ slightly. - Ensure that the following environment variables are set
DEVECO_SDK_HOME
(Required when targetingHarmonyOS NEXT
)OHOS_BASE_SDK_HOME
(Required when targetingOpenHarmony
)OHOS_SDK_NATIVE
(e.g.${DEVECO_SDK_HOME}/default/openharmony/native
or${OHOS_BASE_SDK_HOME}/${API_VERSION}/native
)SERVO_OHOS_SIGNING_CONFIG
: Path to json file containing a valid signing configuration for the demo app.
- Review the detailed instructions at Building for OpenHarmony.
- The target distribution can be modified by passing
--flavor=<default|harmonyos>
to `mach <build|package|install>.