Google Git
Sign in
android / device / google / cuttlefish / 4a9d4bc265ddcbbb383c13a1bd18c7b1b8ff1673
commit4a9d4bc265ddcbbb383c13a1bd18c7b1b8ff1673[log] [tgz]
authorTreehugger Robot <treehugger-gerrit@google.com>Thu Dec 02 03:23:54 2021 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Thu Dec 02 03:23:54 2021 +0000
treedb112af1eb67b58f0515aa5ba29b7da0e2d05e82
parentbebb217bca948149fe2c0c744440132e487608da [diff]
parent3ec2809dfa8ab2288be8085e35be8a581b274f45 [diff]
Merge changes If7cc2fd2,I320e24f7 am: 37825823a0 am: 1e82416059 am: d075bbe01a am: 3ec2809dfa

Original change: https://android-review.googlesource.com/c/device/google/cuttlefish/+/1907917

Change-Id: Id4654f23abc75ad9ba0557eceac89880b94f6b0c
tree: db112af1eb67b58f0515aa5ba29b7da0e2d05e82
  1. apex/
  2. build/
  3. common/
  4. guest/
  5. host/
  6. recovery/
  7. shared/
  8. tests/
  9. tools/
  10. vsoc_arm64/
  11. vsoc_arm64_only/
  12. vsoc_arm_only/
  13. vsoc_x86/
  14. vsoc_x86_64/
  15. vsoc_x86_64_only/
  16. vsoc_x86_noapex/
  17. vsoc_x86_only/
  18. rustfmt.toml ⇨ ../../../build/soong/scripts/rustfmt.toml
  19. .clang-format
  20. Android.bp
  21. Android.mk
  22. AndroidProducts.mk
  23. CleanSpec.mk
  24. default-permissions.xml
  25. dtb.img
  26. fetcher.mk
  27. host_package.mk
  28. METADATA
  29. multiarch-howto.md
  30. OWNERS
  31. PREUPLOAD.cfg
  32. README.md
  33. required_images
  34. tags
  35. TEST_MAPPING
README.md

Cuttlefish Getting Started

Try Cuttlefish

  1. Make sure virtualization with KVM is available.

     grep -c -w "vmx\|svm" /proc/cpuinfo

    This should return a non-zero value. If running on a cloud machine, this may take cloud-vendor-specific steps to enable. For Google Compute Engine specifically, see the GCE guide.

ARM specific steps:

  • When running on an ARM machine, the most direct way is to check for the existence of /dev/kvm. Note that this method can also be used to confirm support of KVM on any environment.
  • Before proceeding to the next step, please first follow the guide to adjust APT sources.

  1. Download, build, and install the host debian package:

    sudo apt install -y git devscripts config-package-dev debhelper-compat
git clone https://github.com/google/android-cuttlefish
cd android-cuttlefish
debuild -i -us -uc -b
sudo dpkg -i ../cuttlefish-common_*_*64.deb || sudo apt-get install -f
sudo usermod -aG kvm,cvdnetwork $USER
sudo reboot

    The reboot will trigger installing additional kernel modules and applying udev rules.

  2. Go to http://ci.android.com/

  3. Enter a branch name. Start with aosp-master if you don‘t know what you’re looking for

  4. Navigate to aosp_cf_x86_64_phone and click on userdebug for the latest build

  5. Click on Artifacts

  6. Scroll down to the OTA images. These packages look like aosp_cf_x86_64_phone-img-xxxxxx.zip -- it will always have img in the name. Download this file

  7. Scroll down to cvd-host_package.tar.gz. You should always download a host package from the same build as your images.

  8. On your local system, combine the packages:

    mkdir cf
cd cf
tar xvf /path/to/cvd-host_package.tar.gz
unzip /path/to/aosp_cf_x86_64_phone-img-xxxxxx.zip

  9. Launch cuttlefish with:

$ HOME=$PWD ./bin/launch_cvd

  1. Stop cuttlefish with:

$ HOME=$PWD ./bin/stop_cvd

Debug Cuttlefish

You can use adb to debug it, just like a physical device:

$ ./bin/adb -e shell

Launch Viewer (WebRTC)

When launching with ---start_webrtc (the default), you can see a list of all available devices at https://localhost:8443 . For more information, see the WebRTC on Cuttlefish documentation.