Skip to content

Latest commit

 

History

History
217 lines (137 loc) · 7.68 KB

DARWIN-DEV.md

File metadata and controls

217 lines (137 loc) · 7.68 KB

Android Emulator MacOS Development

This document describes how to get started with emulator development under MacOS. Throughout the emulator code base and documentation we ofter refer to MacOS as Darwin.

Software Requirements

  • You will need Xcode 10.1 or newer. We recommend 10.1.
  • You will need MacOS10.13 SDK.

We have pinned the compiler and MacOS SDK on the build bots to make sure we do not encounter unexpected issues.

Getting Xcode

We use xcode 10.1 and encourage you to use the same version.

You can obtain Xcode here:

Simply double-click the xip file and it will extract the Xcode application. Move Xcode to the Applications folder and you are good to go.

The next step is to to accept the license and install the command line tools.

sudo xcodebuild -license accept &&
sudo xcode-select --install

  • Note: You can compile with any version of Xcode > 10.1, but might run into issues around Qt. You will only be able to launch the emulator with the -gpu off flag.

  • Note: Xcode is usually installed in /Applications/Xcode.app you might run into unexpected issues if this is not the case.

You can validate that you have an Xcode version available by running:

xcodebuild -version

This should print your Xcode version.

You can obtain the installation directory as follows:

export XCODE_PATH=$(xcode-select -print-path 2>/dev/null)
echo $XCODE_PATH

Usually this prints /Applications/Xcode.app/Contents/Developer.

Obtain MacOS10.13sdk:

The toolchain specifically looks for the MacOS 10.13 SDK, and will fail to configure if you do not have it available. You can get the SDK here:

And extract this to your install, for example:

export XCODE_PATH=$(xcode-select -print-path 2>/dev/null)
sudo tar xvf MacOSX10.13.sdk.tar.gz -C \
$XCODE_PATH/Platforms/MacOSX.platform/Developer/SDKs

Obtaining repo

First we need to obtain the repo tool.

    mkdir $HOME/bin
    curl http://commondatastorage.googleapis.com/git-repo-downloads/repo > $HOME/bin/repo
    chmod 700 $HOME/bin/repo

Make sure to add $HOME/bin to your path, if it is not already there.

 export PATH=$PATH:$HOME/bin

Do not forget to add this to your .bashrc file or .zshrc if you use the z shell.

Initialize the repository:

You can initialize repo as follows:

mkdir -p $HOME/emu-master-dev && cd $HOME/emu-master-dev
repo init -u https://android.googlesource.com/platform/manifest -b emu-master-dev

Sync the repo (and get some coffee, or a have a good nap.)

repo sync -j 8

Congratulations! You have all the sources you need. Now run:

    cd external/qemu && android/rebuild.sh

If all goes well you should have a freshly build emulator in the objs directory:

 ./objs/emulator -list-avds

You can pass the flag --help to the rebuild script to get an idea of which options you can pass in.

Incremental builds

The rebuild script does a complete clean build. You can use ninja to partial builds. The ninja build engine is part of our repository:

    export PATH=$PATH:$HOME/emu-master-dev/prebuilts/ninja/darwin-x86/
    ninja -C objs

Speeding up builds with 'ccache'

It is highly recommended to install the 'ccache' build tool on your development machine(s). The Android emulator build scripts will probe for it and use it if available, which can speed up incremental builds considerably.

    brew install ccache

Optional step

Configure ccache to use a different cache size with ccache -M <max size>. You can see a list of configuration options by calling ccache alone. * The default ccache directory is ~/.ccache. You might want to symlink it to another directory (for example, when using FileVault for your home directory).

Running builds from build bots

When you first download a zip file the build bots the system considers it to be foreign and tags it with a quarantine flag. This flag prevents it from running if it contains executable code. This means you cannot run emulators that you obtain from the build bots.

If you run into this you can remove the quarantine tag as follows:

xattr -dr com.apple.quarantine /path/to/my/unzipped/emulator

Cross compiling to Windows with clang-cl

It is highly recommended to use a windows machine for windows development, vs cross compilation.

It is possible to cross compile from MacOs to windows. This is mainly useful to quickly discover compilation issues, as you will not be able to actually run the code.

The windows target requires you to install the MSVC libraries. These libraries need manual intervention to be installed on your linux machine as you will need to:

  1. Strongly consider not doing this, and develop on a windows machine.

  2. You will need a case insensitive filesystem (you likely have this). See this post to verify if yours is.

  3. You will need the mingw toolchain (we use some program tools from mingw). The easiest way is to install it using homebrew:

    brew install mingw-w64

I'm within google

  • You will have to obtain the windows sdk
export PATH=$PATH:$PWD/android/third_party/chromium/depot_tools/
download_from_google_storage --config
python ./android/third_party/chromium/depot_tools/win_toolchain/get_toolchain_if_necessary.py --toolchain-dir=$AOSP_DIR/prebuilts/android-emulator-build/msvc --force --output-json=res.json 3bc0ec615cf20ee342f3bc29bc991b5ad66d8d2c
ln -sf $AOSP_DIR/prebuilts/android-emulator-build/msvc/vs_files/3bc0ec615cf20ee342f3bc29bc991b5ad66d8d2c $AOSP_DIR/prebuilts/android-emulator-build/msvc/win8sdk

next you will need to have a mingw compiler and realpath. The easiest way to obtain these is through homebrew:

brew install mingw-w64 coreutils

If all went well you can now target windows as follows:

./android/rebuild.sh --target windows

I'm outside Google

  1. You will need to have access to a Windows machine.

  2. Package your Windows SDK installation into a zip file by running the following on a Windows machine:

    cd path/to/depot_tools/win_toolchain
    # customize the Windows SDK version numbers
    python package_from_installed.py 2017 -w 10.0.17134.0
copy the created zip file to your mac. Say win8sdk.zip
  1. Execute the following on your mac:
    mkdir -p /mnt/msvc/win8sdk
    unzip win8sdk.zip -D /mnt/msvc/win8sdk

If all went well you can now target windows as follows:

./android/rebuild.sh --target windows

Sending patches

Here you can find details on submitting patches. No external configuation should be needed if you are within Google.