Default package

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: MainRequest.Create.IoEvent, MainRequest.ReserveRange, MainRequest.SetCallHint, VcpuResponse.Wait.Io

• IOPORT = 0

• MMIO = 1

Used in: CompositeDisk

• string file_path = 1

• uint64 offset = 2

• ReadWriteCapability read_write_capability = 3

• uint64 version = 1

• repeated ComponentDisk component_disks = 2

• uint64 length = 3

Used in: MainResponse.CpuidResponse, VcpuRequest.SetCpuid, VcpuResponse.CpuidResponse

• uint32 function = 1

• bool has_index = 3

• uint32 index = 4

• uint32 eax = 5

• uint32 ebx = 6

• uint32 ecx = 7

• uint32 edx = 8

A request made to the crosvm main process that affects the global aspects of the VM.

• oneof message

  The type of the message is determined by which of these oneof fields is present in the protobuf.

  • MainRequest.Create create = 1

    Common method for instantiating a new object of any type.

  • MainRequest.Destroy destroy = 2

    Common method for destroying an object of any type.

  • MainRequest.NewConnection new_connection = 3

  • MainRequest.GetShutdownEventfd get_shutdown_eventfd = 4

  • MainRequest.CheckExtension check_extension = 5

  • MainRequest.CpuidRequest get_supported_cpuid = 6

  • MainRequest.CpuidRequest get_emulated_cpuid = 7

  • MainRequest.MsrListRequest get_msr_index_list = 8

  • MainRequest.GetNetConfig get_net_config = 9

  • MainRequest.ReserveRange reserve_range = 10

  • MainRequest.SetIrq set_irq = 11

  • MainRequest.SetIrqRouting set_irq_routing = 12

  • MainRequest.GetState get_state = 13

  • MainRequest.SetState set_state = 14

  • MainRequest.SetIdentityMapAddr set_identity_map_addr = 15

  • MainRequest.PauseVcpus pause_vcpus = 16

  • MainRequest.GetVcpus get_vcpus = 17

  • MainRequest.Start start = 18

  • MainRequest.SetCallHint set_call_hint = 19

  • MainRequest.MemoryDirtyLog dirty_log = 101

    Method for a Memory type object for retrieving the dirty bitmap. Only valid if the memory object was created with dirty_log set.

Used in: MainRequest

• uint32 extension = 1

Used in: MainRequest

(message has no fields)

Every message under the Create namespace will instantiate an object with the given ID. The type of object is determined by the oneof constructor field.

Used in: MainRequest

• uint32 id = 1

• oneof constructor

  • Create.IoEvent io_event = 2

  • Create.Memory memory = 3

    This message also requires a memfd sent over the socket.

  • Create.IrqEvent irq_event = 4

Used in: Create

• AddressSpace space = 1

• uint64 address = 2

• uint32 length = 3

• uint64 datamatch = 4

Used in: Create

• uint32 irq_id = 1

• bool resample = 2

Used in: Create

• uint64 offset = 1

• uint64 start = 2

• uint64 length = 3

• bool read_only = 4

• bool dirty_log = 5

  Must be true for the MemoryDirtyLog method to work on this object.

No matter what the type an object is, it can be destroyed using this common method.

Used in: MainRequest

• uint32 id = 1

Used in: MainRequest

(message has no fields)

Used in: MainRequest

(message has no fields)

Used in: MainRequest

• StateSet set = 1

Used in: MainRequest

(message has no fields)

Used in: MainRequest

• uint32 id = 1

Used in: MainRequest

(message has no fields)

Used in: MainRequest

(message has no fields)

Used in: MainRequest

• uint64 cpu_mask = 1

• uint64 user = 2

Used in: MainRequest

• AddressSpace space = 1

• uint64 start = 2

• uint64 length = 3

• bool async_write = 4

Used in: MainRequest

• AddressSpace space = 1

• uint64 address = 2

• bool on_write = 3

• repeated SetCallHint.RegHint hints = 4

Used in: SetCallHint

• bool match_rax = 1

• bool match_rbx = 2

• bool match_rcx = 3

• bool match_rdx = 4

• uint64 rax = 5

• uint64 rbx = 6

• uint64 rcx = 7

• uint64 rdx = 8

• bool send_sregs = 9

• bool send_debugregs = 10

Used in: MainRequest

• uint32 address = 1

Used in: MainRequest

• uint32 irq_id = 1

• bool active = 2

Used in: MainRequest

• repeated SetIrqRouting.Route routes = 1

Used in: SetIrqRouting

• uint32 irq_id = 1

• oneof route

  • Route.Irqchip irqchip = 2

  • Route.Msi msi = 3

Used in: Route

• uint32 irqchip = 1

• uint32 pin = 2

Used in: Route

• uint64 address = 1

• uint32 data = 2

Used in: MainRequest

• StateSet set = 1

• bytes state = 2

  The in memory representation of certain state, depending on the value of the StateSet.

Used in: MainRequest

(message has no fields)

Each type refers to certain piece of VM state (such as PIT state). The structure of the data corresponds to the kvm structure.

Used in: GetState, SetState

• PIC0 = 0

  struct kvm_pic_state

• PIC1 = 1

  struct kvm_pic_state

• IOAPIC = 2

  struct kvm_ioapic_state

• PIT = 3

  struct kvm_pit_state2

• CLOCK = 4

  struct kvm_clock_data

• sint32 errno = 1

  This is zero on success, and a negative integer on failure.

• oneof message

  The field present here is always the same as the one present in the corresponding MainRequest.

  • MainResponse.Create create = 2

  • MainResponse.Destroy destroy = 3

  • MainResponse.NewConnection new_connection = 4

  • MainResponse.GetShutdownEventfd get_shutdown_eventfd = 5

  • MainResponse.CheckExtension check_extension = 6

  • MainResponse.CpuidResponse get_supported_cpuid = 7

  • MainResponse.CpuidResponse get_emulated_cpuid = 8

  • MainResponse.MsrListResponse get_msr_index_list = 9

  • MainResponse.GetNetConfig get_net_config = 10

  • MainResponse.ReserveRange reserve_range = 11

  • MainResponse.SetIrq set_irq = 12

  • MainResponse.SetIrqRouting set_irq_routing = 13

  • MainResponse.GetState get_state = 14

  • MainResponse.SetState set_state = 15

  • MainResponse.SetIdentityMapAddr set_identity_map_addr = 16

  • MainResponse.PauseVcpus pause_vcpus = 17

  • MainResponse.GetVcpus get_vcpus = 18

  • MainResponse.Start start = 19

  • MainResponse.SetCallHint set_call_hint = 20

  • MainResponse.MemoryDirtyLog dirty_log = 101

Used in: MainResponse

• bool has_extension = 1

Used in: MainResponse

• repeated CpuidEntry entries = 1

Depending on the object that was created, an fd might also come from the socket.

Used in: MainResponse

(message has no fields)

Used in: MainResponse

(message has no fields)

GetNetConfig messages also return a file descriptor for the tap device.

Used in: MainResponse

• bytes host_mac_address = 1

• fixed32 host_ipv4_address = 2

• fixed32 netmask = 3

Used in: MainResponse

(message has no fields)

Used in: MainResponse

• bytes state = 1

  The in memory representation of a state, depending on what StateSet was requested in GetState.

This message should also receive a socket fd per VCPU along with the data from reading this socket. The VcpuRequest/VcpuResponse protocol is run over each of the returned fds.

Used in: MainResponse

(message has no fields)

Used in: MainResponse

• bytes bitmap = 1

Used in: MainResponse

• repeated uint32 indices = 1

NewMessage receives a socket fd along with the data from reading this socket. The returned socket can be used totally independently of the original socket, and can perform requests and responses independent of the other sockets.

Used in: MainResponse

(message has no fields)

Used in: MainResponse

(message has no fields)

Used in: MainResponse

(message has no fields)

Used in: MainResponse

(message has no fields)

Used in: MainResponse

(message has no fields)

Used in: MainResponse

(message has no fields)

Used in: MainResponse

(message has no fields)

Used in: MainResponse

(message has no fields)

Used in: MainResponse

(message has no fields)

Used in: ComponentDisk

• READ_ONLY = 0

• READ_WRITE = 1

• oneof Event

  • VirtioBalloonResize resize = 1

  • VirtioBalloonOOMDeflation oom_deflation = 2

  • VirtioBalloonWsReport ws_report = 3

A request made for a specific VCPU. These requests are sent over the sockets returned from the GetVcpu MainRequest.

• oneof message

  The type of the message is determined by which of these oneof fields is present in the protobuf.

  • VcpuRequest.Wait wait = 1

  • VcpuRequest.Resume resume = 2

  • VcpuRequest.GetState get_state = 3

  • VcpuRequest.SetState set_state = 4

  • VcpuRequest.GetMsrs get_msrs = 5

  • VcpuRequest.SetMsrs set_msrs = 6

  • VcpuRequest.SetCpuid set_cpuid = 7

  • VcpuRequest.Shutdown shutdown = 8

  • VcpuRequest.CpuidRequest get_hyperv_cpuid = 9

  • VcpuRequest.EnableCapability enable_capability = 10

Used in: VcpuRequest

(message has no fields)

Used in: VcpuRequest

• uint32 capability = 1

Used in: VcpuRequest

• repeated uint32 entry_indices = 1

  The entry data will be returned in the same order as this in the VcpuResponse::GetMsrs::entry_data array.

Used in: VcpuRequest

• StateSet set = 1

Used in: SetMsrs

• uint32 index = 1

• uint64 data = 2

Used in: VcpuRequest

• bytes data = 1

  The data is only necessary for non-write (read) I/O accesses. In all other cases, data is ignored.

• bytes regs = 2

  The following tracks what deferred set calls to apply.

• bytes sregs = 3

• bytes debugregs = 4

Used in: VcpuRequest

• repeated CpuidEntry entries = 1

Used in: VcpuRequest

• repeated MsrEntry entries = 1

Used in: VcpuRequest

• StateSet set = 1

• bytes state = 2

  The in memory representation of a struct kvm_regs, struct kvm_sregs, struct kvm_fpu, struct kvm_debugregs, struct kvm_lapic_state, struct kvm_mp_state, struct kvm_xcrs or struct kvm_vcpu_events depending on the value of the StateSet.

Used in: VcpuRequest

(message has no fields)

Each type refers to certain piece of VCPU state (a set registers, or something else). The structure of the data corresponds to the kvm structure.

Used in: GetState, SetState

• REGS = 0

  struct kvm_regs

• SREGS = 1

  struct kvm_sregs

• FPU = 2

  struct kvm_fpu

• DEBUGREGS = 3

  struct kvm_debugregs

• LAPIC = 4

  struct kvm_lapic_state

• MP = 5

  struct kvm_mp_state

• XCREGS = 6

  struct kvm_xcrs

• EVENTS = 7

  struct kvm_vcpu_events

This message will block until a non-empty response can be sent. The first response will always be an Init wait reason.

Used in: VcpuRequest

(message has no fields)

• sint32 errno = 1

  This is zero on success, and a negative integer on failure.

• oneof message

  The field present here is always the same as the one present in the corresponding VcpuRequest.

  • VcpuResponse.Wait wait = 2

  • VcpuResponse.GetState get_state = 4

    resume was 3 but no longer gets a reply.

  • VcpuResponse.SetState set_state = 5

  • VcpuResponse.GetMsrs get_msrs = 6

  • VcpuResponse.SetMsrs set_msrs = 7

  • VcpuResponse.SetCpuid set_cpuid = 8

  • VcpuResponse.CpuidResponse get_hyperv_cpuid = 9

  • VcpuResponse.EnableCapability enable_capability = 10

Used in: VcpuResponse

• repeated CpuidEntry entries = 1

Used in: VcpuResponse

(message has no fields)

Used in: VcpuResponse

• repeated uint64 entry_data = 1

  The order of the entry_data values is the same order as the array of indices given in the corresponding request.

Used in: VcpuResponse

• bytes state = 1

  The in memory representation of a struct kvm_regs, struct kvm_sregs, struct kvm_fpu, struct kvm_debugregs, struct kvm_lapic_state, struct kvm_mp_state, struct kvm_xcrs or struct kvm_vcpu_events depending on the value of the StateSet.

Used in: VcpuResponse

(message has no fields)

Used in: VcpuResponse

(message has no fields)

Used in: VcpuResponse

(message has no fields)

Depending on the reason a VCPU has exited, the Wait request will unblock and return a field in the oneof exit. This is called the "wait reason."

Used in: VcpuResponse

• oneof exit

  • Wait.Init init = 1

  • Wait.Io io = 2

  • Wait.User user = 3

  • Wait.HypervCall hyperv_call = 4

  • Wait.HypervSynic hyperv_synic = 5

Used in: Wait

• uint64 input = 1

• uint64 params0 = 2

• uint64 params1 = 3

Used in: Wait

• uint32 msr = 1

• uint64 control = 2

• uint64 evt_page = 3

• uint64 msg_page = 4

This request will always be the first wait reason returend by the first wait request.

Used in: Wait

(message has no fields)

This type of wait reason is only generated if the access occurred on this VCPU on an address previously reserved by a ReserveRange main request.

Used in: Wait

• AddressSpace space = 1

• uint64 address = 2

• bool is_write = 3

• bool no_resume = 4

• bytes data = 5

• bytes regs = 6

  The following can be eagerly provided.

• bytes sregs = 7

• bytes debugregs = 8

This type of wait reason is only generated after a PauseVcpus request on this VCPU.

Used in: Wait

• uint64 user = 1

Used in: RegisteredEvent

(message has no fields)

Used in: RegisteredEvent

(message has no fields)

Used in: RegisteredEvent

• repeated VirtioWsBucket ws_buckets = 1

  2-16 buckets of memory working set.

• uint64 balloon_actual = 2

  actual size of balloon in bytes.

Used in: VirtioBalloonWsReport

• uint64 age = 1

  age of bucket in milliseconds.

• uint64 file_bytes = 2

  file-back memory, in bytes.

• uint64 anon_bytes = 3

  anonymous memory, in bytes.