Google Git
Sign in
mojo / mojo-tools / 8fc79b093ac7811e6506b7bfd3cc937490c570a4
commit8fc79b093ac7811e6506b7bfd3cc937490c570a4[log] [tgz]
authorPrzemyslaw Pietrzkiewicz <ppi@chromium.org>Wed Jun 10 17:44:55 2015 +0200
committerPrzemyslaw Pietrzkiewicz <ppi@chromium.org>Wed Jun 10 17:44:55 2015 +0200
treef4f33b366ff17172ea4ad3f1a60c485232a3bafa
parent8fd3402a91065b05ff19cb0c22dc1bee0c39172f [diff]
README: add <a name> and expand the debugger section.

This is so that other READMEs can link to the `debugger` documentation
here.

R=tonyg@chromium.org

Review URL: https://codereview.chromium.org/1175003002.
1 file changed
tree: f4f33b366ff17172ea4ad3f1a60c485232a3bafa
  1. apps/
  2. base/
  3. benchmarks/
  4. build/
  5. cc/
  6. crypto/
  7. examples/
  8. gin/
  9. gpu/
  10. mojo/
  11. mojom/
  12. nacl_bindings/
  13. nacl_bindings_generator/
  14. sandbox/
  15. services/
  16. shell/
  17. skia/
  18. sky/
  19. testing/
  20. third_party/
  21. tools/
  22. ui/
  23. url/
  24. .clang-format
  25. .gitattributes
  26. .gitignore
  27. .gn
  28. AUTHORS
  29. BUILD.gn
  30. codereview.settings
  31. DEPS
  32. DEPS.nacl
  33. LICENSE
  34. OWNERS
  35. PRESUBMIT.py
  36. PRESUBMIT_test.py
  37. PRESUBMIT_test_mocks.py
  38. README.md
  39. WATCHLISTS
README.md

Mojo

Mojo is an effort to extract a common platform out of Chrome's renderer and plugin processes that can support multiple types of sandboxed content, such as HTML, Pepper, or NaCl.

Set-up and code check-out

The instructions below only need to be done once. Note that a simple “git clone” command is not sufficient to build the source code because this repo uses the gclient command from depot_tools to manage most third party dependencies.

  1. Download depot_tools and make sure it is in your path.
  2. [Googlers only] Install Goma in ~/goma.
  3. Create a directory somewhere for your checkout (preferably on an SSD), cd into it, and run the following commands:
$ fetch mojo # append --target_os=android to include Android build support.
$ cd src

# Or install-build-deps-android.sh if you plan to build for Android.
$ ./build/install-build-deps.sh

$ mojo/tools/mojob.py gn

The “fetch mojo” command does the following:

  • creates a directory called ‘src’ under your checkout directory
  • clones the repository using git clone
  • clones dependencies with gclient sync

install-build-deps.sh installs any packages needed to build, then mojo/tools/mojob.py gn runs gn args and configures the build directory, out/Debug.

If the fetch command fails, you will need to delete the src directory and start over.

Adding Android bits in an existing checkout

If you configured your set-up for Linux and now wish to build for Android, edit the .gclient file in your root Mojo directory (the parent directory to src.) and add this line at the end of the file:

target_os = [u'android',u'linux']

Bring in Android-specific build dependencies:

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

Pull down all of the packages with this command:

$ gclient sync

Build Mojo

Linux

Build Mojo for Linux by running:

$ ninja -C out/Debug -j 10

You can also use the mojob.py script for building. This script automatically calls ninja and sets -j to an appropriate value based on whether Goma (see the section on Goma below) is present. You cannot specify a target name with this script.

mojo/tools/mojob.py gn
mojo/tools/mojob.py build

Run a demo:

out/Debug/mojo_shell mojo:spinning_cube

Run the tests:

mojo/tools/mojob.py test

Create a release build:

mojo/tools/mojob.py gn --release
mojo/tools/mojob.py build --release
mojo/tools/mojob.py test --release

Android

To build for Android, first make sure that your checkout is configured to build for Android. After that you can use the mojob script as follows:

$ mojo/tools/mojob.py gn --android
$ mojo/tools/mojob.py build --android

The result will be in out/android_Debug. If you see javac compile errors, make sure you have an up-to-date JDK

Goma (Googlers only)

If you're a Googler, you can use Goma, a distributed compiler service for open-source projects such as Chrome and Android. If Goma is installed in the default location (~/goma), it will work out-of-the-box with the mojob.py gn, mojob.py build workflow described above.

You can also manually add:

use_goma = true

at the end of the file opened through:

$ gn args out/Debug

After you close the editor gn gen out/Debug will run automatically. Now you can dramatically increase the number of parallel tasks:

$ ninja -C out/Debug -j 1000

Update your checkout

You can update your checkout like this. The order is important. You must do the git pull first because gclient sync is dependent on the current revision.

# Fetch changes from upstream and rebase the current branch on top
$ git pull --rebase
# Update all modules as directed by the DEPS file
$ gclient sync

You do not need to rerun gn gen out/Debug - ninja does so automatically each time you build. You might need to rerun mojo/tools/mojob.py gn if the GN flags have changed.

Contribute

With git you should make all your changes in a local branch. Once your change is committed, you can delete this branch.

Create a local branch named “mywork” and make changes to it.

  cd src
  git new-branch mywork
  vi ...

Commit your change locally. (this doesn't commit your change to the SVN or Git server)

  git commit -a

Fix your source code formatting.

$ git cl format

Upload your change for review.

$ git cl upload

Respond to review comments.

See Contributing code for more detailed git instructions, including how to update your CL when you get review comments. There's a short tutorial that might be helpful to try before making your first change: C++ in Chromium 101.

To land a change after receiving LGTM:

$ git cl land

Don't break the build! Waterfall is here: http://build.chromium.org/p/client.mojo/waterfall

Dart Code

Because the dart analyzer is a bit slow, we don't run it unless the user specifically asks for it. To run the dart analyzer against the list of dart targets in the toplevel BUILD.gn file, run:

$ mojo/tools/mojob.py dartcheck

Run Mojo Shell

mojo_shell.py is a universal shell runner abstracting away the differences between running on Linux and Android. Having built Mojo as described above, a demo app can be run as follows:

mojo/tools/mojo_shell.py mojo:spinning_cube  # Linux.
mojo/tools/mojo_shell.py mojo:spinning_cube  --android # Android.

Pass --sky path_to_sky_file to run a Sky app on either platform:

mojo/tools/mojo_shell.py --sky sky/examples/raw/hello_world.dart
mojo/tools/mojo_shell.py --sky sky/examples/raw/hello_world.dart --android

Passing the -v flag will increase the output verbosity. In particular, it will also print all arguments passed by mojo_shell.py to the shell binary.

Debugging, tracing, profiling

While the shell is running, the debugger script allows you to interactively start tracing and retrieve the result:

/devtools/common/debugger tracing start
/devtools/common/debugger tracing stop result.json

The trace file can be then loaded using the trace viewer in Chrome available at about://tracing.

Android set-up

Adb

For the Android tooling to work, you will need to have adb in your PATH. For that, you can either run:

source build/android/envsetup.sh

each time you open a fresh terminal, or add something like:

export PATH="$PATH":$MOJO_DIR/src/third_party/android_tools/sdk/platform-tools

to your ~/.bashrc file, $MOJO_DIR being a path to your Mojo checkout.

Device

The device has to be running Android 5.0 (Lollipop) or newer.

Many features useful for development (ie. streaming of the shell stdout when running shell on the device) will not work unless the device is rooted and running a userdebug build. For Googlers, follow the instructions at this link.

Aw, snap!

If the shell crashes on the device, you won't see symbols. Use tools/android_stack_parser/stack to map back to symbols, e.g.:

adb logcat | ./tools/android_stack_parser/stack

Running manually on Linux

If you wish to, you can also run the Linux Mojo shell directly with no wrappers:

./out/Debug/mojo_shell mojo:spinning_cube