Google Git
Sign in
android / device / google / cuttlefish / refs/heads/android14-qpr3-s8-release
commit59f1b5b1b7b1bb1fd7dfc7003161c1ec32a3120e[log] [tgz]
authorAndroid Build Coastguard Worker <[email protected]>Sat Mar 02 02:03:14 2024 +0000
committerAndroid Build Coastguard Worker <[email protected]>Sat Mar 02 02:03:14 2024 +0000
treef4d268c4955a2d6846e2028a435a16d7a3f934e5
parent551af05bc99103781338559d7e5d2d17efc54fcf [diff]
parent9687f52a2ec4170a855725a0c97f041bed6f3445 [diff]
Snap for 11520864 from 9687f52a2ec4170a855725a0c97f041bed6f3445 to 24Q2-release

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