android_build_instructions.md 10.9 KB
Newer Older
1 2
# Checking out and building Chromium for Android

3
There are instructions for other platforms linked from the
4
[get the code](get_the_code.md) page.
5

6 7 8 9
## Instructions for Google Employees

Are you a Google employee? See
[go/building-chrome](https://goto.google.com/building-chrome) instead.
10

11 12
[TOC]

13
## System requirements
14

15 16 17 18
* A 64-bit Intel machine running Linux 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 installed already.
19

20
Most development is done on Ubuntu. Other distros may or may not work;
21
see the [Linux instructions](linux_build_instructions.md) for some suggestions.
22

23
Building the Android client on Windows or Mac is not supported and doesn't work.
24

25
## Install `depot_tools`
26

27
Clone the `depot_tools` repository:
28

29 30 31
```shell
$ git clone https://chromium.googlesource.com/chromium/tools/depot_tools.git
```
32

33 34 35
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`:
36

37 38 39
```shell
$ export PATH="$PATH:/path/to/depot_tools"
```
40

41
## Get the code
42

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

47 48 49 50
```shell
$ mkdir ~/chromium && cd ~/chromium
$ fetch --nohooks android
```
51

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

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

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

62 63 64
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:
65

66 67 68
```shell
$ cd src
```
69

70
### Converting an existing Linux checkout
71

72
If you have an existing Linux checkout, you can add Android support by
73 74
appending `target_os = ['android']` to your `.gclient` file (in the
directory above `src`):
75

76 77 78
```shell
$ echo "target_os = [ 'android' ]" >> ../.gclient
```
79

80
Then run `gclient sync` to pull the new Android dependencies:
81

82 83 84
```shell
$ gclient sync
```
85

86
(This is the only difference between `fetch android` and `fetch chromium`.)
87

88
### Install additional build dependencies
89

90 91
Once you have checked out the code, run

92 93 94
```shell
$ build/install-build-deps-android.sh
```
95

96
to get all of the dependencies you need to build on Linux, *plus* all of the
97
Android-specific dependencies (you need some of the regular Linux dependencies
98
because an Android build includes a bunch of the Linux tools and utilities).
99 100 101 102

### Run the hooks

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

106 107 108
```shell
$ gclient runhooks
```
109

110 111 112 113
*Optional*: You can also [install API
keys](https://www.chromium.org/developers/how-tos/api-keys) if you want your
build to talk to some Google services, but this is not necessary for most
development and testing purposes.
114

115
## Setting up the build
116

117 118 119 120 121
Chromium uses [Ninja](https://ninja-build.org) as its main build tool along
with a tool called [GN](../tools/gn/docs/quick_start.md) to generate `.ninja`
files. You can create any number of *build directories* with different
configurations. To create a build directory which builds Chrome for Android,
run:
122

123
```shell
124
$ gn gen --args='target_os="android"' out/Default
125
```
126

127 128 129 130 131 132
* 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](https://www.chromium.org/developers/gn-build-configuration).
133 134 135 136 137
  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](../tools/gn/docs/quick_start.md).

138
Also be aware that some scripts (e.g. `tombstones.py`, `adb_gdb.py`)
139 140 141 142 143 144
require you to set `CHROMIUM_OUTPUT_DIR=out/Default`.

## Build Chromium

Build Chromium with Ninja using the command:

145 146 147 148 149 150 151 152
```shell
$ ninja -C out/Default chrome_public_apk
```

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 `ninja -C
out/Default chrome/test:unit_tests`).
153

154
## Installing and Running Chromium on a device
155

156 157 158
If the `adb_install_apk.py` script below fails, make sure `aapt` is in your
PATH. If not, add `aapt`'s parent directory to your `PATH` environment variable
(it should be
159 160 161 162 163
`/path/to/src/third_party/android_tools/sdk/build-tools/{latest_version}/`).

Prepare the environment:

```shell
164
$ . build/android/envsetup.sh
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
```

### Plug in your Android device

Make sure your Android device is plugged in via USB, and USB Debugging
is enabled.

To enable USB Debugging:

*   Navigate to Settings \> About Phone \> Build number
*   Click 'Build number' 7 times
*   Now navigate back to Settings \> Developer Options
*   Enable 'USB Debugging' and follow the prompts

You may also be prompted to allow access to your PC once your device is
plugged in.

You can check if the device is connected by running:

```shell
third_party/android_tools/sdk/platform-tools/adb devices
```

Which prints a list of connected devices. If not connected, try
unplugging and reattaching your device.
190 191 192 193

### Build the full browser

```shell
194
ninja -C out/Default chrome_public_apk
195 196 197 198 199
```

And deploy it to your Android device:

```shell
200
build/android/adb_install_apk.py out/Default/apks/ChromePublic.apk
201 202 203 204 205 206 207
```

The app will appear on the device as "Chromium".

### Build Content shell

Wraps the content module (but not the /chrome embedder). See
208
[https://www.chromium.org/developers/content-module](https://www.chromium.org/developers/content-module)
209 210 211
for details on the content module and content shell.

```shell
212 213
ninja -C out/Default content_shell_apk
build/android/adb_install_apk.py out/Default/apks/ContentShell.apk
214 215 216
```

this will build and install an Android apk under
217
`out/Default/apks/ContentShell.apk`.
218 219 220 221 222 223 224 225

If you use custom out dir instead of standard out/ dir, use
CHROMIUM_OUT_DIR env.

```shell
export CHROMIUM_OUT_DIR=out_android
```

226
### Build WebView
227

228
[Android WebView](https://developer.android.com/reference/android/webkit/WebView.html)
229
is a system framework component. Since Android KitKat, it is implemented using
230
Chromium code (based off the [content module](https://dev.chromium.org/developers/content-module)).
231

232 233 234 235
If you want to build the complete Android WebView framework component and test
the effect of your chromium changes in Android apps using WebView, you should
follow the [Android AOSP + chromium WebView
instructions](https://www.chromium.org/developers/how-tos/build-instructions-android-webview)
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256

### Running

Set [command line flags](https://www.chromium.org/developers/how-tos/run-chromium-with-flags) if necessary.

For Content shell:

```shell
build/android/adb_run_content_shell  http://example.com
```

For Chrome public:

```shell
build/android/adb_run_chrome_public  http://example.com
```

### Logging and debugging

Logging is often the easiest way to understand code flow. In C++ you can print
log statements using the LOG macro or printf(). In Java, you can print log
257
statements using [android.util.Log](https://developer.android.com/reference/android/util/Log.html):
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284

`Log.d("sometag", "Reticulating splines progress = " + progress);`

You can see these log statements using adb logcat:

```shell
adb logcat...01-14 11:08:53.373 22693 23070 D sometag: Reticulating splines progress = 0.99
```

You can debug Java or C++ code. To debug C++ code, use one of the
following commands:

```shell
build/android/adb_gdb_content_shell
build/android/adb_gdb_chrome_public
```

See [Debugging Chromium on Android](https://www.chromium.org/developers/how-tos/debugging-on-android)
for more on debugging, including how to debug Java code.

### Testing

For information on running tests, see [android\_test\_instructions.md](https://chromium.googlesource.com/chromium/src/+/master/docs/android_test_instructions.md).

### Faster Edit/Deploy (GN only)

GN's "incremental install" uses reflection and side-loading to speed up the edit
285 286
& deploy cycle (normally < 10 seconds). The initial launch of the apk will be
a little slower since updated dex files are installed manually.
287 288 289

*   Make sure to set` is_component_build = true `in your GN args
*   All apk targets have \*`_incremental` targets defined (e.g.
290
    `chrome_public_apk_incremental`) except for Webview and Monochrome
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319

Here's an example:

```shell
ninja -C out/Default chrome_public_apk_incremental
out/Default/bin/install_chrome_public_apk_incremental -v
```

For gunit tests (note that run_*_incremental automatically add
--fast-local-dev when calling test\_runner.py):

```shell
ninja -C out/Default base_unittests_incremental
out/Default/bin/run_base_unittests_incremental
```

For instrumentation tests:

```shell
ninja -C out/Default chrome_public_test_apk_incremental
out/Default/bin/run_chrome_public_test_apk_incremental
```

To uninstall:

```shell
out/Default/bin/install_chrome_public_apk_incremental -v --uninstall
```

320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
A subtly erroneous flow arises when you build a regular apk but install an
incremental apk (e.g.
`ninja -C out/Default foo_apk && out/Default/bin/install_foo_apk_incremental`).
Setting `incremental_apk_by_default = true` in your GN args aliases regular
targets as their incremental counterparts. With this arg set, the commands
above become:

```shell
ninja -C out/Default chrome_public_apk
out/Default/bin/install_chrome_public_apk

ninja -C out/Default base_unittests
out/Default/bin/run_base_unittests

ninja -C out/Default chrome_public_test_apk
out/Default/bin/run_chrome_public_test_apk
```

If you want to build a non-incremental apk you'll need to remove
`incremental_apk_by_default` from your GN args.

341
## Tips, tricks, and troubleshooting
342

343
### Rebuilding libchrome.so for a particular release
344

345 346
These instructions are only necessary for Chrome 51 and earlier.

347 348 349 350 351 352 353 354 355 356 357
In the case where you want to modify the native code for an existing
release of Chrome for Android (v25+) you can do the following steps.
Note that in order to get your changes into the official release, you'll
need to send your change for a codereview using the regular process for
committing code to chromium.

1.  Open Chrome on your Android device and visit chrome://version
2.  Copy down the id listed next to "Build ID:"
3.  Go to
    [http://storage.googleapis.com/chrome-browser-components/BUILD\_ID\_FROM\_STEP\_2/index.html](http://storage.googleapis.com/chrome-browser-components/BUILD_ID_FROM_STEP_2/index.html)
4.  Download the listed files and follow the steps in the README.