Google Git
Sign in
android / device / google / cuttlefish / a62e9d5e37d62d932e107fc44e369c67c62f3714
commita62e9d5e37d62d932e107fc44e369c67c62f3714[log] [tgz]
authorEnrico Granata <[email protected]>Tue Feb 07 16:43:13 2023 -0700
committerEnrico Granata <[email protected]>Wed Feb 08 17:03:07 2023 +0000
treefdf69d61718dd3aa26787ab180d004684783dacb
parent7d0a4c1aab3b76ec82f6860632771a2bd1a20f83 [diff]
Allow downstream devices to configure ro.product.board

Automation tools used by the auto team rely on the lunch target name
matching the board name. This is currently not true for trout, since
it inherits `cutf` from its upstream parent

Bug: 268220206
Test: build cuttlefish, launch, observe no change
      build trout, launch, observe change
Change-Id: I0c6a035913ddf25b1882f89b61dc6461e3a73d29
Merged-In: I0c6a035913ddf25b1882f89b61dc6461e3a73d29
1 file changed
tree: fdf69d61718dd3aa26787ab180d004684783dacb
  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_only/
  17. rustfmt.toml ⇨ ../../../build/soong/scripts/rustfmt.toml
  18. .clang-format
  19. Android.bp
  20. Android.mk
  21. AndroidProducts.mk
  22. CleanSpec.mk
  23. default-permissions.xml
  24. dtb.img
  25. fetcher.mk
  26. host_package.mk
  27. iwyu.imp
  28. METADATA
  29. multiarch-howto.md
  30. OWNERS
  31. PREUPLOAD.cfg
  32. README.md
  33. required_images
  34. 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 golang
git clone https://github.com/google/android-cuttlefish
cd android-cuttlefish
debuild -i -us -uc -b -d
sudo dpkg -i ../cuttlefish-common_*_*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`