Google Git
Sign in
android / device / google / cuttlefish / 04677be3eec3c0b303ce81ed2aaa64a81bac4e4d
commit04677be3eec3c0b303ce81ed2aaa64a81bac4e4d[log] [tgz]
authorXin Li <[email protected]>Fri Aug 25 13:27:06 2023 -0700
committerXin Li <[email protected]>Fri Aug 25 13:27:06 2023 -0700
tree89be697778d3b9b2871ff09a62bf92bfa4e98bf4
parente2167e059c5fcb791df0f7d9e3be263ebeb9aca5 [diff]
parented08d17dda3dc6cd9fa9d7d392541f301f3d5e8a [diff]
Merge Android U (ab/10368041)

Bug: 291102124
Merged-In: Iee32d8c8f551862364bf52bfb275ce4e7fd8099e
Change-Id: I502bb2d6a7119cd9adea82205d661dc7a6ffae53
tree: 89be697778d3b9b2871ff09a62bf92bfa4e98bf4
  1. apex/
  2. build/
  3. common/
  4. guest/
  5. host/
  6. recovery/
  7. shared/
  8. tests/
  9. tools/
  10. vsoc_arm64/
  11. vsoc_arm64_minidroid/
  12. vsoc_arm64_only/
  13. vsoc_arm_minidroid/
  14. vsoc_riscv64/
  15. vsoc_riscv64_minidroid/
  16. vsoc_x86/
  17. vsoc_x86_64/
  18. vsoc_x86_64_host/
  19. vsoc_x86_64_minidroid/
  20. vsoc_x86_64_only/
  21. vsoc_x86_only/
  22. rustfmt.toml ⇨ ../../../build/soong/scripts/rustfmt.toml
  23. .clang-format
  24. Android.bp
  25. Android.mk
  26. AndroidProducts.mk
  27. CleanSpec.mk
  28. default-permissions.xml
  29. dtb.img
  30. fetcher.mk
  31. host_package.mk
  32. iwyu.imp
  33. METADATA
  34. OWNERS
  35. PREUPLOAD.cfg
  36. README.md
  37. required_images
  38. 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.

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

    sudo apt install -y git devscripts config-package-dev debhelper-compat golang curl
git clone https://github.com/google/android-cuttlefish
cd android-cuttlefish
for dir in base frontend; do
  cd $dir
  debuild -i -us -uc -b -d
  cd ..
done
sudo dpkg -i ./cuttlefish-base_*_*64.deb || sudo apt-get install -f
sudo dpkg -i ./cuttlefish-user_*_*64.deb || sudo apt-get install -f
sudo usermod -aG kvm,cvdnetwork,render $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

For ARM, use branch aosp-master-throttled-copped and device target aosp_cf_arm64_only_phone-userdebug

  1. Click on Artifacts

  2. 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

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

  4. 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

  5. Launch cuttlefish with:

$ HOME=$PWD ./bin/launch_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.

Stop Cuttlefish

You will need to stop the virtual device within the same directory as you used to launch the device.

$ HOME=$PWD ./bin/stop_cvd