Google Git
Sign in
android / device / google / cuttlefish / fba27ebb9
commitfba27ebb93d78699c5c816696c414d597b5ca5a6[log] [tgz]
authorSteve Kim <kwstephenkim@google.com>Fri Dec 09 17:16:33 2022 -0800
committerSteve Kim <kwstephenkim@google.com>Mon Dec 12 21:41:09 2022 +0000
tree79510ad4c916355405b1e4b4c9ab9b651e7334a6
parentf9fc5f992ec19f72da37fa1be76e6e7fdd95ec78 [diff]
Subcommand handlers should return the list of subcmds

For the sake of cvd-specific commandline arguments parser,
it should be known which operations/subcommands are valid.
Each subcommand handler is the best place to keep those,
and thus they should also return the list of their subcommands.

To test the new feature, cvd cmd-list is added but not
documented. The command will be removed in the coming CLs.

Bug: 262063179
Test: Run locally: cvd cmd-list
Change-Id: I706369f6653061f9cd5b0636560c8988cc885227
18 files changed
tree: 79510ad4c916355405b1e4b4c9ab9b651e7334a6
  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_only/
  14. vsoc_riscv64/
  15. vsoc_riscv64_minidroid/
  16. vsoc_x86/
  17. vsoc_x86_64/
  18. vsoc_x86_64_minidroid/
  19. vsoc_x86_64_only/
  20. vsoc_x86_only/
  21. rustfmt.toml ⇨ ../../../build/soong/scripts/rustfmt.toml
  22. .clang-format
  23. Android.bp
  24. Android.mk
  25. AndroidProducts.mk
  26. CleanSpec.mk
  27. default-permissions.xml
  28. dtb.img
  29. fetcher.mk
  30. host_package.mk
  31. iwyu.imp
  32. METADATA
  33. OWNERS
  34. PREUPLOAD.cfg
  35. README.md
  36. required_images
  37. 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