docs/interop/vhost-user.txt

   1 Vhost-user Protocol
   2 ===================
   3
   4 Copyright (c) 2014 Virtual Open Systems Sarl.
   5
   6 This work is licensed under the terms of the GNU GPL, version 2 or later.
   7 See the COPYING file in the top-level directory.
   8 ===================
   9
  10 This protocol is aiming to complement the ioctl interface used to control the
  11 vhost implementation in the Linux kernel. It implements the control plane needed
  12 to establish virtqueue sharing with a user space process on the same host. It
  13 uses communication over a Unix domain socket to share file descriptors in the
  14 ancillary data of the message.
  15
  16 The protocol defines 2 sides of the communication, master and slave. Master is
  17 the application that shares its virtqueues, in our case QEMU. Slave is the
  18 consumer of the virtqueues.
  19
  20 In the current implementation QEMU is the Master, and the Slave is intended to
  21 be a software Ethernet switch running in user space, such as Snabbswitch.
  22
  23 Master and slave can be either a client (i.e. connecting) or server (listening)
  24 in the socket communication.
  25
  26 Message Specification
  27 ---------------------
  28
  29 Note that all numbers are in the machine native byte order. A vhost-user message
  30 consists of 3 header fields and a payload:
  31
  32 ------------------------------------
  33 | request | flags | size | payload |
  34 ------------------------------------
  35
  36  * Request: 32-bit type of the request
  37  * Flags: 32-bit bit field:
  38    - Lower 2 bits are the version (currently 0x01)
  39    - Bit 2 is the reply flag - needs to be sent on each reply from the slave
  40    - Bit 3 is the need_reply flag - see VHOST_USER_PROTOCOL_F_REPLY_ACK for
  41      details.
  42  * Size - 32-bit size of the payload
  43
  44
  45 Depending on the request type, payload can be:
  46
  47  * A single 64-bit integer
  48    -------
  49    | u64 |
  50    -------
  51
  52    u64: a 64-bit unsigned integer
  53
  54  * A vring state description
  55    ---------------
  56    | index | num |
  57    ---------------
  58
  59    Index: a 32-bit index
  60    Num: a 32-bit number
  61
  62  * A vring address description
  63    --------------------------------------------------------------
  64    | index | flags | size | descriptor | used | available | log |
  65    --------------------------------------------------------------
  66
  67    Index: a 32-bit vring index
  68    Flags: a 32-bit vring flags
  69    Descriptor: a 64-bit ring address of the vring descriptor table
  70    Used: a 64-bit ring address of the vring used ring
  71    Available: a 64-bit ring address of the vring available ring
  72    Log: a 64-bit guest address for logging
  73
  74    Note that a ring address is an IOVA if VIRTIO_F_IOMMU_PLATFORM has been
  75    negotiated.  Otherwise it is a user address.
  76
  77  * Memory regions description
  78    ---------------------------------------------------
  79    | num regions | padding | region0 | ... | region7 |
  80    ---------------------------------------------------
  81
  82    Num regions: a 32-bit number of regions
  83    Padding: 32-bit
  84
  85    A region is:
  86    -----------------------------------------------------
  87    | guest address | size | user address | mmap offset |
  88    -----------------------------------------------------
  89
  90    Guest address: a 64-bit guest address of the region
  91    Size: a 64-bit size
  92    User address: a 64-bit user address
  93    mmap offset: 64-bit offset where region starts in the mapped memory
  94
  95 * Log description
  96    ---------------------------
  97    | log size | log offset |
  98    ---------------------------
  99    log size: size of area used for logging
 100    log offset: offset from start of supplied file descriptor
 101        where logging starts (i.e. where guest address 0 would be logged)
 102
 103  * An IOTLB message
 104    ---------------------------------------------------------
 105    | iova | size | user address | permissions flags | type |
 106    ---------------------------------------------------------
 107
 108    IOVA: a 64-bit I/O virtual address programmed by the guest
 109    Size: a 64-bit size
 110    User address: a 64-bit user address
 111    Permissions: a 8-bit value:
 112     - 0: No access
 113     - 1: Read access
 114     - 2: Write access
 115     - 3: Read/Write access
 116    Type: a 8-bit IOTLB message type:
 117     - 1: IOTLB miss
 118     - 2: IOTLB update
 119     - 3: IOTLB invalidate
 120     - 4: IOTLB access fail
 121
 122  * Virtio device config space
 123    -----------------------------------
 124    | offset | size | flags | payload |
 125    -----------------------------------
 126
 127    Offset: a 32-bit offset of virtio device's configuration space
 128    Size: a 32-bit configuration space access size in bytes
 129    Flags: a 32-bit value:
 130     - 0: Vhost master messages used for writeable fields
 131     - 1: Vhost master messages used for live migration
 132    Payload: Size bytes array holding the contents of the virtio
 133        device's configuration space
 134
 135 In QEMU the vhost-user message is implemented with the following struct:
 136
 137 typedef struct VhostUserMsg {
 138     VhostUserRequest request;
 139     uint32_t flags;
 140     uint32_t size;
 141     union {
 142         uint64_t u64;
 143         struct vhost_vring_state state;
 144         struct vhost_vring_addr addr;
 145         VhostUserMemory memory;
 146         VhostUserLog log;
 147         struct vhost_iotlb_msg iotlb;
 148         VhostUserConfig config;
 149     };
 150 } QEMU_PACKED VhostUserMsg;
 151
 152 Communication
 153 -------------
 154
 155 The protocol for vhost-user is based on the existing implementation of vhost
 156 for the Linux Kernel. Most messages that can be sent via the Unix domain socket
 157 implementing vhost-user have an equivalent ioctl to the kernel implementation.
 158
 159 The communication consists of master sending message requests and slave sending
 160 message replies. Most of the requests don't require replies. Here is a list of
 161 the ones that do:
 162
 163  * VHOST_USER_GET_FEATURES
 164  * VHOST_USER_GET_PROTOCOL_FEATURES
 165  * VHOST_USER_GET_VRING_BASE
 166  * VHOST_USER_SET_LOG_BASE (if VHOST_USER_PROTOCOL_F_LOG_SHMFD)
 167
 168 [ Also see the section on REPLY_ACK protocol extension. ]
 169
 170 There are several messages that the master sends with file descriptors passed
 171 in the ancillary data:
 172
 173  * VHOST_USER_SET_MEM_TABLE
 174  * VHOST_USER_SET_LOG_BASE (if VHOST_USER_PROTOCOL_F_LOG_SHMFD)
 175  * VHOST_USER_SET_LOG_FD
 176  * VHOST_USER_SET_VRING_KICK
 177  * VHOST_USER_SET_VRING_CALL
 178  * VHOST_USER_SET_VRING_ERR
 179  * VHOST_USER_SET_SLAVE_REQ_FD
 180
 181 If Master is unable to send the full message or receives a wrong reply it will
 182 close the connection. An optional reconnection mechanism can be implemented.
 183
 184 Any protocol extensions are gated by protocol feature bits,
 185 which allows full backwards compatibility on both master
 186 and slave.
 187 As older slaves don't support negotiating protocol features,
 188 a feature bit was dedicated for this purpose:
 189 #define VHOST_USER_F_PROTOCOL_FEATURES 30
 190
 191 Starting and stopping rings
 192 ----------------------
 193 Client must only process each ring when it is started.
 194
 195 Client must only pass data between the ring and the
 196 backend, when the ring is enabled.
 197
 198 If ring is started but disabled, client must process the
 199 ring without talking to the backend.
 200
 201 For example, for a networking device, in the disabled state
 202 client must not supply any new RX packets, but must process
 203 and discard any TX packets.
 204
 205 If VHOST_USER_F_PROTOCOL_FEATURES has not been negotiated, the ring is initialized
 206 in an enabled state.
 207
 208 If VHOST_USER_F_PROTOCOL_FEATURES has been negotiated, the ring is initialized
 209 in a disabled state. Client must not pass data to/from the backend until ring is enabled by
 210 VHOST_USER_SET_VRING_ENABLE with parameter 1, or after it has been disabled by
 211 VHOST_USER_SET_VRING_ENABLE with parameter 0.
 212
 213 Each ring is initialized in a stopped state, client must not process it until
 214 ring is started, or after it has been stopped.
 215
 216 Client must start ring upon receiving a kick (that is, detecting that file
 217 descriptor is readable) on the descriptor specified by
 218 VHOST_USER_SET_VRING_KICK, and stop ring upon receiving
 219 VHOST_USER_GET_VRING_BASE.
 220
 221 While processing the rings (whether they are enabled or not), client must
 222 support changing some configuration aspects on the fly.
 223
 224 Multiple queue support
 225 ----------------------
 226
 227 Multiple queue is treated as a protocol extension, hence the slave has to
 228 implement protocol features first. The multiple queues feature is supported
 229 only when the protocol feature VHOST_USER_PROTOCOL_F_MQ (bit 0) is set.
 230
 231 The max number of queue pairs the slave supports can be queried with message
 232 VHOST_USER_GET_QUEUE_NUM. Master should stop when the number of
 233 requested queues is bigger than that.
 234
 235 As all queues share one connection, the master uses a unique index for each
 236 queue in the sent message to identify a specified queue. One queue pair
 237 is enabled initially. More queues are enabled dynamically, by sending
 238 message VHOST_USER_SET_VRING_ENABLE.
 239
 240 Migration
 241 ---------
 242
 243 During live migration, the master may need to track the modifications
 244 the slave makes to the memory mapped regions. The client should mark
 245 the dirty pages in a log. Once it complies to this logging, it may
 246 declare the VHOST_F_LOG_ALL vhost feature.
 247
 248 To start/stop logging of data/used ring writes, server may send messages
 249 VHOST_USER_SET_FEATURES with VHOST_F_LOG_ALL and VHOST_USER_SET_VRING_ADDR with
 250 VHOST_VRING_F_LOG in ring's flags set to 1/0, respectively.
 251
 252 All the modifications to memory pointed by vring "descriptor" should
 253 be marked. Modifications to "used" vring should be marked if
 254 VHOST_VRING_F_LOG is part of ring's flags.
 255
 256 Dirty pages are of size:
 257 #define VHOST_LOG_PAGE 0x1000
 258
 259 The log memory fd is provided in the ancillary data of
 260 VHOST_USER_SET_LOG_BASE message when the slave has
 261 VHOST_USER_PROTOCOL_F_LOG_SHMFD protocol feature.
 262
 263 The size of the log is supplied as part of VhostUserMsg
 264 which should be large enough to cover all known guest
 265 addresses. Log starts at the supplied offset in the
 266 supplied file descriptor.
 267 The log covers from address 0 to the maximum of guest
 268 regions. In pseudo-code, to mark page at "addr" as dirty:
 269
 270 page = addr / VHOST_LOG_PAGE
 271 log[page / 8] |= 1 << page % 8
 272
 273 Where addr is the guest physical address.
 274
 275 Use atomic operations, as the log may be concurrently manipulated.
 276
 277 Note that when logging modifications to the used ring (when VHOST_VRING_F_LOG
 278 is set for this ring), log_guest_addr should be used to calculate the log
 279 offset: the write to first byte of the used ring is logged at this offset from
 280 log start. Also note that this value might be outside the legal guest physical
 281 address range (i.e. does not have to be covered by the VhostUserMemory table),
 282 but the bit offset of the last byte of the ring must fall within
 283 the size supplied by VhostUserLog.
 284
 285 VHOST_USER_SET_LOG_FD is an optional message with an eventfd in
 286 ancillary data, it may be used to inform the master that the log has
 287 been modified.
 288
 289 Once the source has finished migration, rings will be stopped by
 290 the source. No further update must be done before rings are
 291 restarted.
 292
 293 Memory access
 294 -------------
 295
 296 The master sends a list of vhost memory regions to the slave using the
 297 VHOST_USER_SET_MEM_TABLE message.  Each region has two base addresses: a guest
 298 address and a user address.
 299
 300 Messages contain guest addresses and/or user addresses to reference locations
 301 within the shared memory.  The mapping of these addresses works as follows.
 302
 303 User addresses map to the vhost memory region containing that user address.
 304
 305 When the VIRTIO_F_IOMMU_PLATFORM feature has not been negotiated:
 306
 307  * Guest addresses map to the vhost memory region containing that guest
 308    address.
 309
 310 When the VIRTIO_F_IOMMU_PLATFORM feature has been negotiated:
 311
 312  * Guest addresses are also called I/O virtual addresses (IOVAs).  They are
 313    translated to user addresses via the IOTLB.
 314
 315  * The vhost memory region guest address is not used.
 316
 317 IOMMU support
 318 -------------
 319
 320 When the VIRTIO_F_IOMMU_PLATFORM feature has been negotiated, the master
 321 sends IOTLB entries update & invalidation by sending VHOST_USER_IOTLB_MSG
 322 requests to the slave with a struct vhost_iotlb_msg as payload. For update
 323 events, the iotlb payload has to be filled with the update message type (2),
 324 the I/O virtual address, the size, the user virtual address, and the
 325 permissions flags. Addresses and size must be within vhost memory regions set
 326 via the VHOST_USER_SET_MEM_TABLE request. For invalidation events, the iotlb
 327 payload has to be filled with the invalidation message type (3), the I/O virtual
 328 address and the size. On success, the slave is expected to reply with a zero
 329 payload, non-zero otherwise.
 330
 331 The slave relies on the slave communcation channel (see "Slave communication"
 332 section below) to send IOTLB miss and access failure events, by sending
 333 VHOST_USER_SLAVE_IOTLB_MSG requests to the master with a struct vhost_iotlb_msg
 334 as payload. For miss events, the iotlb payload has to be filled with the miss
 335 message type (1), the I/O virtual address and the permissions flags. For access
 336 failure event, the iotlb payload has to be filled with the access failure
 337 message type (4), the I/O virtual address and the permissions flags.
 338 For synchronization purpose, the slave may rely on the reply-ack feature,
 339 so the master may send a reply when operation is completed if the reply-ack
 340 feature is negotiated and slaves requests a reply. For miss events, completed
 341 operation means either master sent an update message containing the IOTLB entry
 342 containing requested address and permission, or master sent nothing if the IOTLB
 343 miss message is invalid (invalid IOVA or permission).
 344
 345 The master isn't expected to take the initiative to send IOTLB update messages,
 346 as the slave sends IOTLB miss messages for the guest virtual memory areas it
 347 needs to access.
 348
 349 Slave communication
 350 -------------------
 351
 352 An optional communication channel is provided if the slave declares
 353 VHOST_USER_PROTOCOL_F_SLAVE_REQ protocol feature, to allow the slave to make
 354 requests to the master.
 355
 356 The fd is provided via VHOST_USER_SET_SLAVE_REQ_FD ancillary data.
 357
 358 A slave may then send VHOST_USER_SLAVE_* messages to the master
 359 using this fd communication channel.
 360
 361 Protocol features
 362 -----------------
 363
 364 #define VHOST_USER_PROTOCOL_F_MQ             0
 365 #define VHOST_USER_PROTOCOL_F_LOG_SHMFD      1
 366 #define VHOST_USER_PROTOCOL_F_RARP           2
 367 #define VHOST_USER_PROTOCOL_F_REPLY_ACK      3
 368 #define VHOST_USER_PROTOCOL_F_MTU            4
 369 #define VHOST_USER_PROTOCOL_F_SLAVE_REQ      5
 370 #define VHOST_USER_PROTOCOL_F_CROSS_ENDIAN   6
 371 #define VHOST_USER_PROTOCOL_F_CRYPTO_SESSION 7
 372
 373 Master message types
 374 --------------------
 375
 376  * VHOST_USER_GET_FEATURES
 377
 378       Id: 1
 379       Equivalent ioctl: VHOST_GET_FEATURES
 380       Master payload: N/A
 381       Slave payload: u64
 382
 383       Get from the underlying vhost implementation the features bitmask.
 384       Feature bit VHOST_USER_F_PROTOCOL_FEATURES signals slave support for
 385       VHOST_USER_GET_PROTOCOL_FEATURES and VHOST_USER_SET_PROTOCOL_FEATURES.
 386
 387  * VHOST_USER_SET_FEATURES
 388
 389       Id: 2
 390       Ioctl: VHOST_SET_FEATURES
 391       Master payload: u64
 392
 393       Enable features in the underlying vhost implementation using a bitmask.
 394       Feature bit VHOST_USER_F_PROTOCOL_FEATURES signals slave support for
 395       VHOST_USER_GET_PROTOCOL_FEATURES and VHOST_USER_SET_PROTOCOL_FEATURES.
 396
 397  * VHOST_USER_GET_PROTOCOL_FEATURES
 398
 399       Id: 15
 400       Equivalent ioctl: VHOST_GET_FEATURES
 401       Master payload: N/A
 402       Slave payload: u64
 403
 404       Get the protocol feature bitmask from the underlying vhost implementation.
 405       Only legal if feature bit VHOST_USER_F_PROTOCOL_FEATURES is present in
 406       VHOST_USER_GET_FEATURES.
 407       Note: slave that reported VHOST_USER_F_PROTOCOL_FEATURES must support
 408       this message even before VHOST_USER_SET_FEATURES was called.
 409
 410  * VHOST_USER_SET_PROTOCOL_FEATURES
 411
 412       Id: 16
 413       Ioctl: VHOST_SET_FEATURES
 414       Master payload: u64
 415
 416       Enable protocol features in the underlying vhost implementation.
 417       Only legal if feature bit VHOST_USER_F_PROTOCOL_FEATURES is present in
 418       VHOST_USER_GET_FEATURES.
 419       Note: slave that reported VHOST_USER_F_PROTOCOL_FEATURES must support
 420       this message even before VHOST_USER_SET_FEATURES was called.
 421
 422  * VHOST_USER_SET_OWNER
 423
 424       Id: 3
 425       Equivalent ioctl: VHOST_SET_OWNER
 426       Master payload: N/A
 427
 428       Issued when a new connection is established. It sets the current Master
 429       as an owner of the session. This can be used on the Slave as a
 430       "session start" flag.
 431
 432  * VHOST_USER_RESET_OWNER
 433
 434       Id: 4
 435       Master payload: N/A
 436
 437       This is no longer used. Used to be sent to request disabling
 438       all rings, but some clients interpreted it to also discard
 439       connection state (this interpretation would lead to bugs).
 440       It is recommended that clients either ignore this message,
 441       or use it to disable all rings.
 442
 443  * VHOST_USER_SET_MEM_TABLE
 444
 445       Id: 5
 446       Equivalent ioctl: VHOST_SET_MEM_TABLE
 447       Master payload: memory regions description
 448
 449       Sets the memory map regions on the slave so it can translate the vring
 450       addresses. In the ancillary data there is an array of file descriptors
 451       for each memory mapped region. The size and ordering of the fds matches
 452       the number and ordering of memory regions.
 453
 454  * VHOST_USER_SET_LOG_BASE
 455
 456       Id: 6
 457       Equivalent ioctl: VHOST_SET_LOG_BASE
 458       Master payload: u64
 459       Slave payload: N/A
 460
 461       Sets logging shared memory space.
 462       When slave has VHOST_USER_PROTOCOL_F_LOG_SHMFD protocol
 463       feature, the log memory fd is provided in the ancillary data of
 464       VHOST_USER_SET_LOG_BASE message, the size and offset of shared
 465       memory area provided in the message.
 466
 467
 468  * VHOST_USER_SET_LOG_FD
 469
 470       Id: 7
 471       Equivalent ioctl: VHOST_SET_LOG_FD
 472       Master payload: N/A
 473
 474       Sets the logging file descriptor, which is passed as ancillary data.
 475
 476  * VHOST_USER_SET_VRING_NUM
 477
 478       Id: 8
 479       Equivalent ioctl: VHOST_SET_VRING_NUM
 480       Master payload: vring state description
 481
 482       Set the size of the queue.
 483
 484  * VHOST_USER_SET_VRING_ADDR
 485
 486       Id: 9
 487       Equivalent ioctl: VHOST_SET_VRING_ADDR
 488       Master payload: vring address description
 489       Slave payload: N/A
 490
 491       Sets the addresses of the different aspects of the vring.
 492
 493  * VHOST_USER_SET_VRING_BASE
 494
 495       Id: 10
 496       Equivalent ioctl: VHOST_SET_VRING_BASE
 497       Master payload: vring state description
 498
 499       Sets the base offset in the available vring.
 500
 501  * VHOST_USER_GET_VRING_BASE
 502
 503       Id: 11
 504       Equivalent ioctl: VHOST_USER_GET_VRING_BASE
 505       Master payload: vring state description
 506       Slave payload: vring state description
 507
 508       Get the available vring base offset.
 509
 510  * VHOST_USER_SET_VRING_KICK
 511
 512       Id: 12
 513       Equivalent ioctl: VHOST_SET_VRING_KICK
 514       Master payload: u64
 515
 516       Set the event file descriptor for adding buffers to the vring. It
 517       is passed in the ancillary data.
 518       Bits (0-7) of the payload contain the vring index. Bit 8 is the
 519       invalid FD flag. This flag is set when there is no file descriptor
 520       in the ancillary data. This signals that polling should be used
 521       instead of waiting for a kick.
 522
 523  * VHOST_USER_SET_VRING_CALL
 524
 525       Id: 13
 526       Equivalent ioctl: VHOST_SET_VRING_CALL
 527       Master payload: u64
 528
 529       Set the event file descriptor to signal when buffers are used. It
 530       is passed in the ancillary data.
 531       Bits (0-7) of the payload contain the vring index. Bit 8 is the
 532       invalid FD flag. This flag is set when there is no file descriptor
 533       in the ancillary data. This signals that polling will be used
 534       instead of waiting for the call.
 535
 536  * VHOST_USER_SET_VRING_ERR
 537
 538       Id: 14
 539       Equivalent ioctl: VHOST_SET_VRING_ERR
 540       Master payload: u64
 541
 542       Set the event file descriptor to signal when error occurs. It
 543       is passed in the ancillary data.
 544       Bits (0-7) of the payload contain the vring index. Bit 8 is the
 545       invalid FD flag. This flag is set when there is no file descriptor
 546       in the ancillary data.
 547
 548  * VHOST_USER_GET_QUEUE_NUM
 549
 550       Id: 17
 551       Equivalent ioctl: N/A
 552       Master payload: N/A
 553       Slave payload: u64
 554
 555       Query how many queues the backend supports. This request should be
 556       sent only when VHOST_USER_PROTOCOL_F_MQ is set in queried protocol
 557       features by VHOST_USER_GET_PROTOCOL_FEATURES.
 558
 559  * VHOST_USER_SET_VRING_ENABLE
 560
 561       Id: 18
 562       Equivalent ioctl: N/A
 563       Master payload: vring state description
 564
 565       Signal slave to enable or disable corresponding vring.
 566       This request should be sent only when VHOST_USER_F_PROTOCOL_FEATURES
 567       has been negotiated.
 568
 569  * VHOST_USER_SEND_RARP
 570
 571       Id: 19
 572       Equivalent ioctl: N/A
 573       Master payload: u64
 574
 575       Ask vhost user backend to broadcast a fake RARP to notify the migration
 576       is terminated for guest that does not support GUEST_ANNOUNCE.
 577       Only legal if feature bit VHOST_USER_F_PROTOCOL_FEATURES is present in
 578       VHOST_USER_GET_FEATURES and protocol feature bit VHOST_USER_PROTOCOL_F_RARP
 579       is present in VHOST_USER_GET_PROTOCOL_FEATURES.
 580       The first 6 bytes of the payload contain the mac address of the guest to
 581       allow the vhost user backend to construct and broadcast the fake RARP.
 582
 583  * VHOST_USER_NET_SET_MTU
 584
 585       Id: 20
 586       Equivalent ioctl: N/A
 587       Master payload: u64
 588
 589       Set host MTU value exposed to the guest.
 590       This request should be sent only when VIRTIO_NET_F_MTU feature has been
 591       successfully negotiated, VHOST_USER_F_PROTOCOL_FEATURES is present in
 592       VHOST_USER_GET_FEATURES and protocol feature bit
 593       VHOST_USER_PROTOCOL_F_NET_MTU is present in
 594       VHOST_USER_GET_PROTOCOL_FEATURES.
 595       If VHOST_USER_PROTOCOL_F_REPLY_ACK is negotiated, slave must respond
 596       with zero in case the specified MTU is valid, or non-zero otherwise.
 597
 598  * VHOST_USER_SET_SLAVE_REQ_FD
 599
 600       Id: 21
 601       Equivalent ioctl: N/A
 602       Master payload: N/A
 603
 604       Set the socket file descriptor for slave initiated requests. It is passed
 605       in the ancillary data.
 606       This request should be sent only when VHOST_USER_F_PROTOCOL_FEATURES
 607       has been negotiated, and protocol feature bit VHOST_USER_PROTOCOL_F_SLAVE_REQ
 608       bit is present in VHOST_USER_GET_PROTOCOL_FEATURES.
 609       If VHOST_USER_PROTOCOL_F_REPLY_ACK is negotiated, slave must respond
 610       with zero for success, non-zero otherwise.
 611
 612  * VHOST_USER_IOTLB_MSG
 613
 614       Id: 22
 615       Equivalent ioctl: N/A (equivalent to VHOST_IOTLB_MSG message type)
 616       Master payload: struct vhost_iotlb_msg
 617       Slave payload: u64
 618
 619       Send IOTLB messages with struct vhost_iotlb_msg as payload.
 620       Master sends such requests to update and invalidate entries in the device
 621       IOTLB. The slave has to acknowledge the request with sending zero as u64
 622       payload for success, non-zero otherwise.
 623       This request should be send only when VIRTIO_F_IOMMU_PLATFORM feature
 624       has been successfully negotiated.
 625
 626  * VHOST_USER_SET_VRING_ENDIAN
 627
 628       Id: 23
 629       Equivalent ioctl: VHOST_SET_VRING_ENDIAN
 630       Master payload: vring state description
 631
 632       Set the endianess of a VQ for legacy devices. Little-endian is indicated
 633       with state.num set to 0 and big-endian is indicated with state.num set
 634       to 1. Other values are invalid.
 635       This request should be sent only when VHOST_USER_PROTOCOL_F_CROSS_ENDIAN
 636       has been negotiated.
 637       Backends that negotiated this feature should handle both endianesses
 638       and expect this message once (per VQ) during device configuration
 639       (ie. before the master starts the VQ).
 640
 641  * VHOST_USER_GET_CONFIG
 642
 643       Id: 24
 644       Equivalent ioctl: N/A
 645       Master payload: virtio device config space
 646       Slave payload: virtio device config space
 647
 648       Submitted by the vhost-user master to fetch the contents of the virtio
 649       device configuration space, vhost-user slave's payload size MUST match
 650       master's request, vhost-user slave uses zero length of payload to
 651       indicate an error to vhost-user master. The vhost-user master may
 652       cache the contents to avoid repeated VHOST_USER_GET_CONFIG calls.
 653
 654 * VHOST_USER_SET_CONFIG
 655
 656       Id: 25
 657       Equivalent ioctl: N/A
 658       Master payload: virtio device config space
 659       Slave payload: N/A
 660
 661       Submitted by the vhost-user master when the Guest changes the virtio
 662       device configuration space and also can be used for live migration
 663       on the destination host. The vhost-user slave must check the flags
 664       field, and slaves MUST NOT accept SET_CONFIG for read-only
 665       configuration space fields unless the live migration bit is set.
 666
 667 * VHOST_USER_CREATE_CRYPTO_SESSION
 668
 669      Id: 26
 670      Equivalent ioctl: N/A
 671      Master payload: crypto session description
 672      Slave payload: crypto session description
 673
 674      Create a session for crypto operation. The server side must return the
 675      session id, 0 or positive for success, negative for failure.
 676      This request should be sent only when VHOST_USER_PROTOCOL_F_CRYPTO_SESSION
 677      feature has been successfully negotiated.
 678      It's a required feature for crypto devices.
 679
 680 * VHOST_USER_CLOSE_CRYPTO_SESSION
 681
 682      Id: 27
 683      Equivalent ioctl: N/A
 684      Master payload: u64
 685
 686      Close a session for crypto operation which was previously
 687      created by VHOST_USER_CREATE_CRYPTO_SESSION.
 688      This request should be sent only when VHOST_USER_PROTOCOL_F_CRYPTO_SESSION
 689      feature has been successfully negotiated.
 690      It's a required feature for crypto devices.
 691
 692 Slave message types
 693 -------------------
 694
 695  * VHOST_USER_SLAVE_IOTLB_MSG
 696
 697       Id: 1
 698       Equivalent ioctl: N/A (equivalent to VHOST_IOTLB_MSG message type)
 699       Slave payload: struct vhost_iotlb_msg
 700       Master payload: N/A
 701
 702       Send IOTLB messages with struct vhost_iotlb_msg as payload.
 703       Slave sends such requests to notify of an IOTLB miss, or an IOTLB
 704       access failure. If VHOST_USER_PROTOCOL_F_REPLY_ACK is negotiated,
 705       and slave set the VHOST_USER_NEED_REPLY flag, master must respond with
 706       zero when operation is successfully completed, or non-zero otherwise.
 707       This request should be send only when VIRTIO_F_IOMMU_PLATFORM feature
 708       has been successfully negotiated.
 709
 710 * VHOST_USER_SLAVE_CONFIG_CHANGE_MSG
 711
 712      Id: 2
 713      Equivalent ioctl: N/A
 714      Slave payload: N/A
 715      Master payload: N/A
 716
 717      Vhost-user slave sends such messages to notify that the virtio device's
 718      configuration space has changed, for those host devices which can support
 719      such feature, host driver can send VHOST_USER_GET_CONFIG message to slave
 720      to get the latest content. If VHOST_USER_PROTOCOL_F_REPLY_ACK is
 721      negotiated, and slave set the VHOST_USER_NEED_REPLY flag, master must
 722      respond with zero when operation is successfully completed, or non-zero
 723      otherwise.
 724
 725 VHOST_USER_PROTOCOL_F_REPLY_ACK:
 726 -------------------------------
 727 The original vhost-user specification only demands replies for certain
 728 commands. This differs from the vhost protocol implementation where commands
 729 are sent over an ioctl() call and block until the client has completed.
 730
 731 With this protocol extension negotiated, the sender (QEMU) can set the
 732 "need_reply" [Bit 3] flag to any command. This indicates that
 733 the client MUST respond with a Payload VhostUserMsg indicating success or
 734 failure. The payload should be set to zero on success or non-zero on failure,
 735 unless the message already has an explicit reply body.
 736
 737 The response payload gives QEMU a deterministic indication of the result
 738 of the command. Today, QEMU is expected to terminate the main vhost-user
 739 loop upon receiving such errors. In future, qemu could be taught to be more
 740 resilient for selective requests.
 741
 742 For the message types that already solicit a reply from the client, the
 743 presence of VHOST_USER_PROTOCOL_F_REPLY_ACK or need_reply bit being set brings
 744 no behavioural change. (See the 'Communication' section for details.)