Crate crosvm_control

Provides parts of crosvm as a library to communicate with running crosvm instances.

This crate is a programmatic alternative to invoking crosvm with subcommands that produce the result on stdout.

Downstream projects rely on this library maintaining a stable API surface. Do not make changes to this library without consulting the crosvm externalization team. Email: crosvm-dev@chromium.org

The API of this library should remain the same regardless of which crosvm features are enabled. Any missing functionality should be handled by returning an error at runtime, not conditional compilation, so that users can rely on the the same set of functions with the same prototypes regardless of how crosvm is configured.

For more information see: https://crosvm.dev/book/running_crosvm/programmatic_interaction.html#usage

Structs

• BalloonStatsFfi
  Similar to internally used BalloonStats but using i64 instead of Option<u64>. None (or values bigger than i64::max) will be encoded as -1.
• BalloonWSFfi
• BalloonWSRConfigFfi
• RegisteredEventFfi
  Publically exposed version of RegisteredEvent enum, implemented as an integral newtype for FFI safety.
• SwapDisableArgs
  Arguments structure for crosvm_client_swap_disable_vm2.
• SwapStatus
  The response to crosvm swap status command.
• UsbDeviceEntry
  Represents an individual attached USB device.
• WorkingSetBucketFfi
  Externally exposed variant of BalloonWS/WSBucket, used for FFI.

Constants

• REGISTERED_EVENT_VIRTIO_BALLOON_OOM_DEFLATION
• REGISTERED_EVENT_VIRTIO_BALLOON_RESIZE
• REGISTERED_EVENT_VIRTIO_BALLOON_WS_REPORT
• VIRTIO_BALLOON_WS_MAX_NUM_BINS
• VIRTIO_BALLOON_WS_MAX_NUM_INTERVALS

Functions

• crosvm_client_balloon_stats^⚠
  Returns balloon stats of the crosvm instance whose control socket is listening on socket_path.
• crosvm_client_balloon_stats_impl 🔒 ^⚠
  Safety
• crosvm_client_balloon_stats_with_timeout^⚠
  See crosvm_client_balloon_stats.
• crosvm_client_balloon_vms^⚠
  Adjusts the balloon size of the crosvm instance whose control socket is listening on socket_path.
• crosvm_client_balloon_vms_wait_with_timeout^⚠
  See crosvm_client_balloon_vms.
• crosvm_client_balloon_working_set^⚠
  Returns balloon working set of the crosvm instance whose control socket is listening on socket_path.
• crosvm_client_balloon_wsr_config^⚠
  Set Working Set Reporting config in guest.
• crosvm_client_cancel_fake_power^⚠
  Resume the battery status of crosvm instance from fake status
• crosvm_client_fake_power^⚠
  Fakes the battery status of crosvm instance. The power status will always be on battery, and the maximum battery capacity could be read by guest is set to the max_battery_capacity.
• crosvm_client_make_rt_vm^⚠
  Creates an RT vCPU for the crosvm instance whose control socket is listening on socket_path.
• crosvm_client_max_usb_devices
  Simply returns the maximum possible number of USB devices
• crosvm_client_modify_battery^⚠
  Modifies the battery status of crosvm instance whose control socket is listening on socket_path.
• crosvm_client_net_tap_attach^⚠
  Attaches a net tap device to the crosvm instance with control socket at socket_path.
• crosvm_client_net_tap_detach^⚠
  Detaches a hotplugged tap device from the crosvm instance with control socket at socket_path.
• crosvm_client_register_events_listener^⚠
  Registers the connected process as a listener for event.
• crosvm_client_resize_disk^⚠
  Resizes the disk of the crosvm instance whose control socket is listening on socket_path.
• crosvm_client_resume_vm^⚠
  Resumes the crosvm instance whose control socket is listening on socket_path.
• crosvm_client_resume_vm_full^⚠
  Resumes the crosvm instance whose control socket is listening on socket_path.
• crosvm_client_security_key_attach^⚠
  Attaches a u2f security key to crosvm instance whose control socket is listening on socket_path.
• crosvm_client_stop_vm^⚠
  Stops the crosvm instance whose control socket is listening on socket_path.
• crosvm_client_suspend_vm^⚠
  Suspends the crosvm instance whose control socket is listening on socket_path.
• crosvm_client_swap_disable_vm^⚠
  Disable vmm swap according to args.
• crosvm_client_swap_enable_vm^⚠
  Enable vmm swap for crosvm instance whose control socket is listening on socket_path.
• crosvm_client_swap_status^⚠
  Returns vmm-swap status of the crosvm instance whose control socket is listening on socket_path.
• crosvm_client_swap_swapout_vm^⚠
  Swap out staging memory for crosvm instance whose control socket is listening on socket_path.
• crosvm_client_swap_trim^⚠
  Trim staging memory for vmm swap for crosvm instance whose control socket is listening on socket_path.
• crosvm_client_unregister_events_listener^⚠
  Unegisters the connected process as a listener for event.
• crosvm_client_unregister_listener^⚠
  Unegisters the connected process as a listener for all events.
• crosvm_client_usb_attach^⚠
  Attaches an USB device to crosvm instance whose control socket is listening on socket_path.
• crosvm_client_usb_detach^⚠
  Detaches an USB device from crosvm instance whose control socket is listening on socket_path. port determines device to be detached.
• crosvm_client_usb_list^⚠
  Returns all USB devices passed through the crosvm instance whose control socket is listening on socket_path.
• validate_socket_path 🔒 ^⚠
  Safety