Google Git
Sign in
android / device / google / cuttlefish / ae3a81950e6db0290551be43b4d1d71af4c9d059
commitae3a81950e6db0290551be43b4d1d71af4c9d059[log] [tgz]
authorA. Cody Schuffelen <[email protected]>Wed Jun 12 04:36:59 2024 +0000
committerAutomerger Merge Worker <[email protected]>Wed Jun 12 04:36:59 2024 +0000
tree5622208fcfaec31f1a1fcba5685abd7131f47ae5
parent277b25899c43e823fcfd143254955fc21081c36d [diff]
parentad10a9a914e7a8eb3b2a3c30878a4d6be0534133 [diff]
Use a multiport console in qemu_manager.cpp am: ad10a9a914

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

Change-Id: Ic4bacb523a8119cce3b93c3cc56722b41e06bfed
Signed-off-by: Automerger Merge Worker <[email protected]>
tree: 5622208fcfaec31f1a1fcba5685abd7131f47ae5
  1. .vscode/
  2. apex/
  3. build/
  4. common/
  5. guest/
  6. host/
  7. recovery/
  8. shared/
  9. system_image/
  10. tests/
  11. tools/
  12. vsoc_arm64/
  13. vsoc_arm64_minidroid/
  14. vsoc_arm64_only/
  15. vsoc_arm64_pgagnostic/
  16. vsoc_arm_minidroid/
  17. vsoc_riscv64/
  18. vsoc_riscv64_minidroid/
  19. vsoc_x86/
  20. vsoc_x86_64/
  21. vsoc_x86_64_host/
  22. vsoc_x86_64_minidroid/
  23. vsoc_x86_64_only/
  24. vsoc_x86_64_pgagnostic/
  25. vsoc_x86_only/
  26. rustfmt.toml ⇨ ../../../build/soong/scripts/rustfmt.toml
  27. .clang-format
  28. Android.bp
  29. Android.mk
  30. AndroidProducts.mk
  31. CleanSpec.mk
  32. default-permissions.xml
  33. dtb.img
  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
sudo apt install devscripts equivs
for dir in base frontend; do
  pushd $dir
  sudo mk-build-deps -i
  dpkg-buildpackage -uc -us
  popd
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