Checking out and building Chromium on Linux

发行：

autoninja -C out/release "chrome/installer/linux:stable_rpm"
autoninja -C out/release "chrome/installer/linux:stable_deb"

Checking out and building Chromium on Linux

There are instructions for other platforms linked from the get the code page.

Instructions for Google Employees

Are you a Google employee? See go/building-chrome instead.

System requirements

A 64-bit Intel machine with at least 8GB of RAM. More than 16GB is highly recommended.
At least 100GB of free disk space.
You must have Git and Python v2 installed already.

Most development is done on Ubuntu (currently 16.04, Xenial Xerus). There are some instructions for other distros below, but they are mostly unsupported.

Install `depot_tools`

Clone the depot_tools repository:

$ git clone https://chromium.googlesource.com/chromium/tools/depot_tools.git

Add depot_tools to the end of your PATH (you will probably want to put this in your ~/.bashrc or ~/.zshrc). Assuming you cloned depot_tools to /path/to/depot_tools:

$ export PATH="$PATH:/path/to/depot_tools"

When cloning depot_tools to your home directory do not use ~ on PATH, otherwise gclient runhooks will fail to run. Rather, you should use either $HOME or the absolute path:

$ export PATH="$PATH:${HOME}/depot_tools"

Get the code

Create a chromium directory for the checkout and change to it (you can call this whatever you like and put it wherever you like, as long as the full path has no spaces):

$ mkdir ~/chromium && cd ~/chromium

Run the fetch tool from depot_tools to check out the code and its dependencies.

$ fetch --nohooks chromium

If you don't want the full repo history, you can save a lot of time by adding the --no-history flag to fetch.

Expect the command to take 30 minutes on even a fast connection, and many hours on slower ones.

If you've already installed the build dependencies on the machine (from another checkout, for example), you can omit the --nohooks flag and fetch will automatically execute gclient runhooks at the end.

When fetch completes, it will have created a hidden .gclient file and a directory called src in the working directory. The remaining instructions assume you have switched to the src directory:

$ cd src

Install additional build dependencies

Once you have checked out the code, and assuming you're using Ubuntu, run build/install-build-deps.sh

$ ./build/install-build-deps.sh

You may need to adjust the build dependencies for other distros. There are some notes at the end of this document, but we make no guarantees for their accuracy.

Run the hooks

Once you've run install-build-deps at least once, you can now run the Chromium-specific hooks, which will download additional binaries and other things you might need:

$ gclient runhooks

Optional: You can also install API keys if you want your build to talk to some Google services, but this is not necessary for most development and testing purposes.

Setting up the build

Chromium uses Ninja as its main build tool along with a tool called GN to generate .ninja files. You can create any number of build directories with different configurations. To create a build directory, run:

$ gn gen out/Default

You only have to run this once for each new build directory, Ninja will update the build files as needed.
You can replace Default with another name, but it should be a subdirectory of out.
For other build arguments, including release settings, see GN build configuration. The default will be a debug component build matching the current host operating system and CPU.
For more info on GN, run gn help on the command line or read the quick start guide.

Faster builds

This section contains some things you can change to speed up your builds, sorted so that the things that make the biggest difference are first.

Use Goma

Google developed the distributed compiler called Goma. Googlers and contributors who have tryjob access could use Goma.

If you are not a Googler and would like to use Goma sign up.

Once you've allowed to use Goma service and installed the client, set the following GN args:

use_goma=true
goma_dir="/path/to/goma-client"

Disable NaCl

By default, the build includes support for Native Client (NaCl), but most of the time you won‘t need it. You can set the GN argument enable_nacl=false and it won’t be built.

Include fewer debug symbols

By default GN produces a build with all of the debug assertions enabled (is_debug=true) and including full debug info (symbol_level=2). Setting symbol_level=1 will produce enough information for stack traces, but not line-by-line debugging. Setting symbol_level=0 will include no debug symbols at all. Either will speed up the build compared to full symbols.

Disable debug symbols for Blink

Due to its extensive use of templates, the Blink code produces about half of our debug symbols. If you don't ever need to debug Blink, you can set the GN arg blink_symbol_level=0.

Use Icecc

Icecc is the distributed compiler with a central scheduler to share build load. Currently, many external contributors use it. e.g. Intel, Opera, Samsung (this is not useful if you're using Goma).

In order to use icecc, set the following GN args:

linux_use_bundled_binutils=false
use_debug_fission=false
is_clang=false

See these links for more on the bundled_binutils limitation, the debug fission limitation.

Using the system linker may also be necessary when using glibc 2.21 or newer. See related bug.

ccache

You can use ccache to speed up local builds (again, this is not useful if you're using Goma).

Increase your ccache hit rate by setting CCACHE_BASEDIR to a parent directory that the working directories all have in common (e.g., /home/yourusername/development). Consider using CCACHE_SLOPPINESS=include_file_mtime (since if you are using multiple working directories, header times in svn sync'ed portions of your trees will be different - see the ccache troubleshooting section for additional information). If you use symbolic links from your home directory to get to the local physical disk directory where you keep those working development directories, consider putting

alias cd="cd -P"

in your .bashrc so that $PWD or cwd always refers to a physical, not logical directory (and make sure CCACHE_BASEDIR also refers to a physical parent).

If you tune ccache correctly, a second working directory that uses a branch tracking trunk and is up to date with trunk and was gclient sync'ed at about the same time should build chrome in about 1/3 the time, and the cache misses as reported by ccache -s should barely increase.

This is especially useful if you use git-new-workdir and keep multiple local working directories going at once.

Using tmpfs

You can use tmpfs for the build output to reduce the amount of disk writes required. I.e. mount tmpfs to the output directory where the build output goes:

As root:

mount -t tmpfs -o size=20G,nr_inodes=40k,mode=1777 tmpfs /path/to/out

Caveat: You need to have enough RAM + swap to back the tmpfs. For a full debug build, you will need about 20 GB. Less for just building the chrome target or for a release build.

Quick and dirty benchmark numbers on a HP Z600 (Intel core i7, 16 cores hyperthreaded, 12 GB RAM)

With tmpfs:
- 12m:20s
Without tmpfs
- 15m:40s

Build Chromium

Build Chromium (the “chrome” target) with Ninja using the command:

$ autoninja -C out/Default chrome

(autoninja is a wrapper that automatically provides optimal values for the arguments passed to ninja.)

You can get a list of all of the other build targets from GN by running gn ls out/Default from the command line. To compile one, pass the GN label to Ninja with no preceding “//” (so, for //chrome/test:unit_tests use autoninja -C out/Default chrome/test:unit_tests).

Run Chromium

Once it is built, you can simply run the browser:

$ out/Default/chrome

Running test targets

You can run the tests in the same way. You can also limit which tests are run using the --gtest_filter arg, e.g.:

$ out/Default/unit_tests --gtest_filter="PushClientTest.*"

You can find out more about GoogleTest at its GitHub page.

Update your checkout

To update an existing checkout, you can run

$ git rebase-update
$ gclient sync

The first command updates the primary Chromium source repository and rebases any of your local branches on top of tip-of-tree (aka the Git branch origin/master). If you don't want to use this script, you can also just use git pull or other common Git commands to update the repo.

The second command syncs dependencies to the appropriate versions and re-runs hooks as needed.

Tips, tricks, and troubleshooting

Linker Crashes

If, during the final link stage:

LINK out/Debug/chrome

You get an error like:

collect2: ld terminated with signal 6 Aborted terminate called after throwing an instance of 'std::bad_alloc'
collect2: ld terminated with signal 11 [Segmentation fault], core dumped

you are probably running out of memory when linking. You must use a 64-bit system to build. Try the following build settings (see GN build configuration for other settings):

Build in release mode (debugging symbols require more memory): is_debug = false
Turn off symbols: symbol_level = 0
Build in component mode (this is for development only, it will be slower and may have broken functionality): is_component_build = true

Next Steps

If you want to contribute to the effort toward a Chromium-based browser for Linux, please check out the Linux Development page for more information.

Notes for other distros

Arch Linux

Instead of running install-build-deps.sh to install build dependencies, run:

$ sudo pacman -S --needed python perl gcc gcc-libs bison flex gperf pkgconfig \
nss alsa-lib glib2 gtk3 nspr ttf-ms-fonts freetype2 cairo dbus libgnome-keyring

For the optional packages on Arch Linux:

php-cgi is provided with pacman
wdiff is not in the main repository but dwdiff is. You can get wdiff in AUR/yaourt
sun-java6-fonts do not seem to be in main repository or AUR.

Crostini (Debian based)

First install the file and lsb-release commands for the script to run properly:

$ sudo apt-get install file lsb-release

Then invoke install-build-deps.sh with the --no-arm argument, because the ARM toolchain doesn't exist for this configuration:

$ sudo install-build-deps.sh --no-arm

Fedora

Instead of running build/install-build-deps.sh, run:

su -c 'yum install git python bzip2 tar pkgconfig atk-devel alsa-lib-devel \
bison binutils brlapi-devel bluez-libs-devel bzip2-devel cairo-devel \
cups-devel dbus-devel dbus-glib-devel expat-devel fontconfig-devel \
freetype-devel gcc-c++ glib2-devel glibc.i686 gperf glib2-devel \
gtk3-devel java-1.*.0-openjdk-devel libatomic libcap-devel libffi-devel \
libgcc.i686 libgnome-keyring-devel libjpeg-devel libstdc++.i686 libX11-devel \
libXScrnSaver-devel libXtst-devel libxkbcommon-x11-devel ncurses-compat-libs \
nspr-devel nss-devel pam-devel pango-devel pciutils-devel \
pulseaudio-libs-devel zlib.i686 httpd mod_ssl php php-cli python-psutil wdiff \
xorg-x11-server-Xvfb'

The fonts needed by Blink's web tests can be obtained by following these instructions. For the optional packages:

php-cgi is provided by the php-cli package.
sun-java6-fonts is covered by the instructions linked above.

Gentoo

You can just run emerge www-client/chromium.

OpenSUSE

Use zypper command to install dependencies:

(openSUSE 11.1 and higher)

sudo zypper in subversion pkg-config python perl bison flex gperf \
     mozilla-nss-devel glib2-devel gtk-devel wdiff lighttpd gcc gcc-c++ \
     mozilla-nspr mozilla-nspr-devel php5-fastcgi alsa-devel libexpat-devel \
     libjpeg-devel libbz2-devel

For 11.0, use libnspr4-0d and libnspr4-dev instead of mozilla-nspr and mozilla-nspr-devel, and use php5-cgi instead of php5-fastcgi.

(openSUSE 11.0)

sudo zypper in subversion pkg-config python perl \
     bison flex gperf mozilla-nss-devel glib2-devel gtk-devel \
     libnspr4-0d libnspr4-dev wdiff lighttpd gcc gcc-c++ libexpat-devel \
     php5-cgi alsa-devel gtk3-devel jpeg-devel

The Ubuntu package sun-java6-fonts contains a subset of Java of the fonts used. Since this package requires Java as a prerequisite anyway, we can do the same thing by just installing the equivalent openSUSE Sun Java package:

sudo zypper in java-1_6_0-sun

WebKit is currently hard-linked to the Microsoft fonts. To install these using zypper

sudo zypper in fetchmsttfonts pullin-msttf-fonts

To make the fonts installed above work, as the paths are hardcoded for Ubuntu, create symlinks to the appropriate locations:

sudo mkdir -p /usr/share/fonts/truetype/msttcorefonts
sudo ln -s /usr/share/fonts/truetype/arial.ttf /usr/share/fonts/truetype/msttcorefonts/Arial.ttf
sudo ln -s /usr/share/fonts/truetype/arialbd.ttf /usr/share/fonts/truetype/msttcorefonts/Arial_Bold.ttf
sudo ln -s /usr/share/fonts/truetype/arialbi.ttf /usr/share/fonts/truetype/msttcorefonts/Arial_Bold_Italic.ttf
sudo ln -s /usr/share/fonts/truetype/ariali.ttf /usr/share/fonts/truetype/msttcorefonts/Arial_Italic.ttf
sudo ln -s /usr/share/fonts/truetype/comic.ttf /usr/share/fonts/truetype/msttcorefonts/Comic_Sans_MS.ttf
sudo ln -s /usr/share/fonts/truetype/comicbd.ttf /usr/share/fonts/truetype/msttcorefonts/Comic_Sans_MS_Bold.ttf
sudo ln -s /usr/share/fonts/truetype/cour.ttf /usr/share/fonts/truetype/msttcorefonts/Courier_New.ttf
sudo ln -s /usr/share/fonts/truetype/courbd.ttf /usr/share/fonts/truetype/msttcorefonts/Courier_New_Bold.ttf
sudo ln -s /usr/share/fonts/truetype/courbi.ttf /usr/share/fonts/truetype/msttcorefonts/Courier_New_Bold_Italic.ttf
sudo ln -s /usr/share/fonts/truetype/couri.ttf /usr/share/fonts/truetype/msttcorefonts/Courier_New_Italic.ttf
sudo ln -s /usr/share/fonts/truetype/impact.ttf /usr/share/fonts/truetype/msttcorefonts/Impact.ttf
sudo ln -s /usr/share/fonts/truetype/times.ttf /usr/share/fonts/truetype/msttcorefonts/Times_New_Roman.ttf
sudo ln -s /usr/share/fonts/truetype/timesbd.ttf /usr/share/fonts/truetype/msttcorefonts/Times_New_Roman_Bold.ttf
sudo ln -s /usr/share/fonts/truetype/timesbi.ttf /usr/share/fonts/truetype/msttcorefonts/Times_New_Roman_Bold_Italic.ttf
sudo ln -s /usr/share/fonts/truetype/timesi.ttf /usr/share/fonts/truetype/msttcorefonts/Times_New_Roman_Italic.ttf
sudo ln -s /usr/share/fonts/truetype/verdana.ttf /usr/share/fonts/truetype/msttcorefonts/Verdana.ttf
sudo ln -s /usr/share/fonts/truetype/verdanab.ttf /usr/share/fonts/truetype/msttcorefonts/Verdana_Bold.ttf
sudo ln -s /usr/share/fonts/truetype/verdanai.ttf /usr/share/fonts/truetype/msttcorefonts/Verdana_Italic.ttf
sudo ln -s /usr/share/fonts/truetype/verdanaz.ttf /usr/share/fonts/truetype/msttcorefonts/Verdana_Bold_Italic.ttf

sudo zypper in java-1_6_0-sun

WebKit is currently hard-linked to the Microsoft fonts. To install these using zypper

sudo zypper in fetchmsttfonts pullin-msttf-fonts

To make the fonts installed above work, as the paths are hardcoded for Ubuntu, create symlinks to the appropriate locations:

sudo mkdir -p /usr/share/fonts/truetype/msttcorefonts
sudo ln -s /usr/share/fonts/truetype/arial.ttf /usr/share/fonts/truetype/msttcorefonts/Arial.ttf
sudo ln -s /usr/share/fonts/truetype/arialbd.ttf /usr/share/fonts/truetype/msttcorefonts/Arial_Bold.ttf
sudo ln -s /usr/share/fonts/truetype/arialbi.ttf /usr/share/fonts/truetype/msttcorefonts/Arial_Bold_Italic.ttf
sudo ln -s /usr/share/fonts/truetype/ariali.ttf /usr/share/fonts/truetype/msttcorefonts/Arial_Italic.ttf
sudo ln -s /usr/share/fonts/truetype/comic.ttf /usr/share/fonts/truetype/msttcorefonts/Comic_Sans_MS.ttf
sudo ln -s /usr/share/fonts/truetype/comicbd.ttf /usr/share/fonts/truetype/msttcorefonts/Comic_Sans_MS_Bold.ttf
sudo ln -s /usr/share/fonts/truetype/cour.ttf /usr/share/fonts/truetype/msttcorefonts/Courier_New.ttf
sudo ln -s /usr/share/fonts/truetype/courbd.ttf /usr/share/fonts/truetype/msttcorefonts/Courier_New_Bold.ttf
sudo ln -s /usr/share/fonts/truetype/courbi.ttf /usr/share/fonts/truetype/msttcorefonts/Courier_New_Bold_Italic.ttf
sudo ln -s /usr/share/fonts/truetype/couri.ttf /usr/share/fonts/truetype/msttcorefonts/Courier_New_Italic.ttf
sudo ln -s /usr/share/fonts/truetype/impact.ttf /usr/share/fonts/truetype/msttcorefonts/Impact.ttf
sudo ln -s /usr/share/fonts/truetype/times.ttf /usr/share/fonts/truetype/msttcorefonts/Times_New_Roman.ttf
sudo ln -s /usr/share/fonts/truetype/timesbd.ttf /usr/share/fonts/truetype/msttcorefonts/Times_New_Roman_Bold.ttf
sudo ln -s /usr/share/fonts/truetype/timesbi.ttf /usr/share/fonts/truetype/msttcorefonts/Times_New_Roman_Bold_Italic.ttf
sudo ln -s /usr/share/fonts/truetype/timesi.ttf /usr/share/fonts/truetype/msttcorefonts/Times_New_Roman_Italic.ttf
sudo ln -s /usr/share/fonts/truetype/verdana.ttf /usr/share/fonts/truetype/msttcorefonts/Verdana.ttf
sudo ln -s /usr/share/fonts/truetype/verdanab.ttf /usr/share/fonts/truetype/msttcorefonts/Verdana_Bold.ttf
sudo ln -s /usr/share/fonts/truetype/verdanai.ttf /usr/share/fonts/truetype/msttcorefonts/Verdana_Italic.ttf
sudo ln -s /usr/share/fonts/truetype/verdanaz.ttf /usr/share/fonts/truetype/msttcorefonts/Verdana_Bold_Italic.ttf

And then for the Java fonts:

sudo mkdir -p /usr/share/fonts/truetype/ttf-lucida
sudo find /usr/lib*/jvm/java-1.6.*-sun-*/jre/lib -iname '*.ttf' -print \
     -exec ln -s {} /usr/share/fonts/truetype/ttf-lucida \;

1.编译chromium

1. 前言

做了两年Chromium相关的开发，最近项目遇到瓶颈，自己有点迷茫。回顾之前做的工作，发现对chromium的认识还停留在非常表面的水平。因此，一直想对之前做的做个总结，只有总结反思才能提高。

2. 编译环境

Label	推荐配置
系统版本	Ubuntu 18.04 64bit
处理器	x86_64
内存	8GB以上
硬盘	150GB以上空闲磁盘

这里采用Ubuntu编译Linux版本，总体翻译自：https://chromium.googlesource.com/chromium/src/+/master/docs/linux_build_instructions.md 。
如果想编译Windows版本，请自行查阅google文档：https://chromium.googlesource.com/chromium/src/+/master/docs/windows_build_instructions.md 。

此外由于谷歌很多网站国内无法访问，还需自行准备上网工具。

3. 安装工具软件

3.1 git

安装git:

$ sudo apt-get install git

做一下配置：

git config --global user.name "Your Name"
$ git config --global user.email "your-email"
$ git config --global core.autocrlf input
$ git config --global core.filemode false
$ git config --global branch.autosetuprebase always

需要提一下core.autocrlf的配置主要是解决Linux和Windows跨平台协作时文件换行符不统一的问题。它有三种取值：

input: git在提交时把CRLF转换成LF，签出时不转换;
true: 提交时自动地把行结束符CRLF转换成LF，而在签出代码时把LF转换成CRLF;
false: 提交和签出代码均不会做更改。

在Linux上是建议设成input，windows上设置成true(当然如果你只是开发windows程序，设成false就可以了)。

3.2 python 2.7

sudo apt-get install python

3.3 depot_tools

git clone https://chromium.googlesource.com/chromium/tools/depot_tools.git

添加到系统环境,编辑~/.bashrc，添加：

export PATH="$PATH:/path/to/depot_tools"

然后生效配置：source ~/.bashrc。

此时你可以使用gclient等命令。

4. 获取chromium源码

首先创建一个chromium目录用于存放代码：

mkdir ~/chromium && cd ~/chromium

运行depot_tools的fetch工具来检出源码及其依赖项:

fetch --nohooks chromium [--no-history]

使用--no-history会让下载的源码不带提交历史信息，是最新的主分支代码，代码量会小很多。不使用该选项会获取完整历史信息的chromium源码。

下载过程可能无法一番风顺，经常出现下载中断的情况，此时请使用：

gclient sync --nohooks

以继续下载。

下载完成之后，进入到代码目录：

cd src

如果你没有使用--no-history参数，那么此时你可以选择切换指定分支，可以参考：https://dev.chromium.org/developers/calendar 找到当前最新的stable分支。以 77.0.3865.90为例：

git fetch --tags
git checkout -b stable_77 tags/77.0.3865.90
gclient sync --with_branch_heads --nohooks --job 16

5. 安装依赖项

如果你是在Ubuntu下进行编译，那么还在编译之前需要安装一些依赖工具，google已经写好了脚本:

build/install-build-deps.sh

6. 运行hooks

hook直译是钩子。在chromium中代码编译是通过gclient来管理的，gclient 的核心功能是将项目中由DEPS文件定义的所有git仓库拉取到指定的目录或者运行指定脚本。为此添加了了hook功能。运行hook也即表示当前代码并不完整，你可能需要的额外的二进制文件或者运行指定脚本。

gclient runhooks

7. 编译

首先需要设置编译选项：

gn args out/Default

这条命令会打开一个文件，我们需要在该文件中加入编译选项：

is_debug = false
symbol_level = 0
enable_nacl = false
remove_webcore_debug_symbols = true

#ffmpeg setting
ffmpeg_branding = "Chrome" 
proprietary_codecs = true

可以通过gn args out/Default --list来查看具体有哪些编译选项可选。

此外，如果你需要使用google服务，那么你需要在参数中加入你的google api key:

google_api_key = "your_api_key"
google_default_client_id = "your_client_id"
google_default_client_secret = "your_client_secret"

要申请请参考：https://www.chromium.org/developers/how-tos/api-keys 。

设置完编译选项后，就可以开始进行编译：

ninja -C out/Default chrome

时间比较久，不出意外，编译成功后，你就可以运行：

out/Default/chrome

至此，就完成了chromium的编译。由于chromium代码量很大，再加上众所周知的网络原因，检出代码、运行hooks都会非常耗时，最后的编译，如果你的机器配置不是很好，编译会非常久，因此有条件一定要使用固态硬盘，否则你可能会抓狂。

8. 补充：如何编译Linux上运行的chromeos版本

如果想编译chromeos版本，需要向.gclient文件中加入平台信息：

echo target_os=[\"chromeos\"] >> .gclient

然后使用gclient sync更新代码。

最后在编译时，需要加上编译参数：

target_os = "chromeos"

这样编译出来的chrome版本是一个模拟chromeos的版本。

posted @ 2020-03-23 12:01 Bigben 阅读(850) 评论(0) 编辑收藏举报

刷新页面返回顶部

Bigben

Checking out and building Chromium on Linux

Checking out and building Chromium on Linux

Instructions for Google Employees

Contents

System requirements

Install depot_tools

Get the code

Install additional build dependencies

Run the hooks

Setting up the build

Faster builds

Use Goma

Disable NaCl

Include fewer debug symbols

Disable debug symbols for Blink

Use Icecc

ccache

Using tmpfs

Build Chromium

Run Chromium

Running test targets

Update your checkout

Tips, tricks, and troubleshooting

Linker Crashes

More links

Next Steps

Notes for other distros

Arch Linux

Crostini (Debian based)

Fedora

Gentoo

OpenSUSE

1.编译chromium

1. 前言

2. 编译环境

3. 安装工具软件

3.1 git

3.2 python 2.7

3.3 depot_tools

4. 获取chromium源码

5. 安装依赖项

6. 运行hooks

7. 编译

8. 补充：如何编译Linux上运行的chromeos版本

Install `depot_tools`