target/ppc: Fix slbia TLB invalidation gap
[qemu.git] / docs / interop / vhost-user.rst
1 ===================
2 Vhost-user Protocol
3 ===================
4 :Copyright: 2014 Virtual Open Systems Sarl.
5 :Copyright: 2019 Intel Corporation
6 :Licence: This work is licensed under the terms of the GNU GPL,
7           version 2 or later. See the COPYING file in the top-level
8           directory.
9
10 .. contents:: Table of Contents
11
12 Introduction
13 ============
14
15 This protocol is aiming to complement the ``ioctl`` interface used to
16 control the vhost implementation in the Linux kernel. It implements
17 the control plane needed to establish virtqueue sharing with a user
18 space process on the same host. It uses communication over a Unix
19 domain socket to share file descriptors in the ancillary data of the
20 message.
21
22 The protocol defines 2 sides of the communication, *master* and
23 *slave*. *Master* is the application that shares its virtqueues, in
24 our case QEMU. *Slave* is the consumer of the virtqueues.
25
26 In the current implementation QEMU is the *master*, and the *slave* is
27 the external process consuming the virtio queues, for example a
28 software Ethernet switch running in user space, such as Snabbswitch,
29 or a block device backend processing read & write to a virtual
30 disk. In order to facilitate interoperability between various backend
31 implementations, it is recommended to follow the :ref:`Backend program
32 conventions <backend_conventions>`.
33
34 *Master* and *slave* can be either a client (i.e. connecting) or
35 server (listening) in the socket communication.
36
37 Message Specification
38 =====================
39
40 .. Note:: All numbers are in the machine native byte order.
41
42 A vhost-user message consists of 3 header fields and a payload.
43
44 +---------+-------+------+---------+
45 | request | flags | size | payload |
46 +---------+-------+------+---------+
47
48 Header
49 ------
50
51 :request: 32-bit type of the request
52
53 :flags: 32-bit bit field
54
55 - Lower 2 bits are the version (currently 0x01)
56 - Bit 2 is the reply flag - needs to be sent on each reply from the slave
57 - Bit 3 is the need_reply flag - see :ref:`REPLY_ACK <reply_ack>` for
58   details.
59
60 :size: 32-bit size of the payload
61
62 Payload
63 -------
64
65 Depending on the request type, **payload** can be:
66
67 A single 64-bit integer
68 ^^^^^^^^^^^^^^^^^^^^^^^
69
70 +-----+
71 | u64 |
72 +-----+
73
74 :u64: a 64-bit unsigned integer
75
76 A vring state description
77 ^^^^^^^^^^^^^^^^^^^^^^^^^
78
79 +-------+-----+
80 | index | num |
81 +-------+-----+
82
83 :index: a 32-bit index
84
85 :num: a 32-bit number
86
87 A vring address description
88 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
89
90 +-------+-------+------+------------+------+-----------+-----+
91 | index | flags | size | descriptor | used | available | log |
92 +-------+-------+------+------------+------+-----------+-----+
93
94 :index: a 32-bit vring index
95
96 :flags: a 32-bit vring flags
97
98 :descriptor: a 64-bit ring address of the vring descriptor table
99
100 :used: a 64-bit ring address of the vring used ring
101
102 :available: a 64-bit ring address of the vring available ring
103
104 :log: a 64-bit guest address for logging
105
106 Note that a ring address is an IOVA if ``VIRTIO_F_IOMMU_PLATFORM`` has
107 been negotiated. Otherwise it is a user address.
108
109 Memory regions description
110 ^^^^^^^^^^^^^^^^^^^^^^^^^^
111
112 +-------------+---------+---------+-----+---------+
113 | num regions | padding | region0 | ... | region7 |
114 +-------------+---------+---------+-----+---------+
115
116 :num regions: a 32-bit number of regions
117
118 :padding: 32-bit
119
120 A region is:
121
122 +---------------+------+--------------+-------------+
123 | guest address | size | user address | mmap offset |
124 +---------------+------+--------------+-------------+
125
126 :guest address: a 64-bit guest address of the region
127
128 :size: a 64-bit size
129
130 :user address: a 64-bit user address
131
132 :mmap offset: 64-bit offset where region starts in the mapped memory
133
134 Log description
135 ^^^^^^^^^^^^^^^
136
137 +----------+------------+
138 | log size | log offset |
139 +----------+------------+
140
141 :log size: size of area used for logging
142
143 :log offset: offset from start of supplied file descriptor where
144              logging starts (i.e. where guest address 0 would be
145              logged)
146
147 An IOTLB message
148 ^^^^^^^^^^^^^^^^
149
150 +------+------+--------------+-------------------+------+
151 | iova | size | user address | permissions flags | type |
152 +------+------+--------------+-------------------+------+
153
154 :iova: a 64-bit I/O virtual address programmed by the guest
155
156 :size: a 64-bit size
157
158 :user address: a 64-bit user address
159
160 :permissions flags: an 8-bit value:
161   - 0: No access
162   - 1: Read access
163   - 2: Write access
164   - 3: Read/Write access
165
166 :type: an 8-bit IOTLB message type:
167   - 1: IOTLB miss
168   - 2: IOTLB update
169   - 3: IOTLB invalidate
170   - 4: IOTLB access fail
171
172 Virtio device config space
173 ^^^^^^^^^^^^^^^^^^^^^^^^^^
174
175 +--------+------+-------+---------+
176 | offset | size | flags | payload |
177 +--------+------+-------+---------+
178
179 :offset: a 32-bit offset of virtio device's configuration space
180
181 :size: a 32-bit configuration space access size in bytes
182
183 :flags: a 32-bit value:
184   - 0: Vhost master messages used for writeable fields
185   - 1: Vhost master messages used for live migration
186
187 :payload: Size bytes array holding the contents of the virtio
188           device's configuration space
189
190 Vring area description
191 ^^^^^^^^^^^^^^^^^^^^^^
192
193 +-----+------+--------+
194 | u64 | size | offset |
195 +-----+------+--------+
196
197 :u64: a 64-bit integer contains vring index and flags
198
199 :size: a 64-bit size of this area
200
201 :offset: a 64-bit offset of this area from the start of the
202          supplied file descriptor
203
204 Inflight description
205 ^^^^^^^^^^^^^^^^^^^^
206
207 +-----------+-------------+------------+------------+
208 | mmap size | mmap offset | num queues | queue size |
209 +-----------+-------------+------------+------------+
210
211 :mmap size: a 64-bit size of area to track inflight I/O
212
213 :mmap offset: a 64-bit offset of this area from the start
214               of the supplied file descriptor
215
216 :num queues: a 16-bit number of virtqueues
217
218 :queue size: a 16-bit size of virtqueues
219
220 C structure
221 -----------
222
223 In QEMU the vhost-user message is implemented with the following struct:
224
225 .. code:: c
226
227   typedef struct VhostUserMsg {
228       VhostUserRequest request;
229       uint32_t flags;
230       uint32_t size;
231       union {
232           uint64_t u64;
233           struct vhost_vring_state state;
234           struct vhost_vring_addr addr;
235           VhostUserMemory memory;
236           VhostUserLog log;
237           struct vhost_iotlb_msg iotlb;
238           VhostUserConfig config;
239           VhostUserVringArea area;
240           VhostUserInflight inflight;
241       };
242   } QEMU_PACKED VhostUserMsg;
243
244 Communication
245 =============
246
247 The protocol for vhost-user is based on the existing implementation of
248 vhost for the Linux Kernel. Most messages that can be sent via the
249 Unix domain socket implementing vhost-user have an equivalent ioctl to
250 the kernel implementation.
251
252 The communication consists of *master* sending message requests and
253 *slave* sending message replies. Most of the requests don't require
254 replies. Here is a list of the ones that do:
255
256 * ``VHOST_USER_GET_FEATURES``
257 * ``VHOST_USER_GET_PROTOCOL_FEATURES``
258 * ``VHOST_USER_GET_VRING_BASE``
259 * ``VHOST_USER_SET_LOG_BASE`` (if ``VHOST_USER_PROTOCOL_F_LOG_SHMFD``)
260 * ``VHOST_USER_GET_INFLIGHT_FD`` (if ``VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD``)
261
262 .. seealso::
263
264    :ref:`REPLY_ACK <reply_ack>`
265        The section on ``REPLY_ACK`` protocol extension.
266
267 There are several messages that the master sends with file descriptors passed
268 in the ancillary data:
269
270 * ``VHOST_USER_SET_MEM_TABLE``
271 * ``VHOST_USER_SET_LOG_BASE`` (if ``VHOST_USER_PROTOCOL_F_LOG_SHMFD``)
272 * ``VHOST_USER_SET_LOG_FD``
273 * ``VHOST_USER_SET_VRING_KICK``
274 * ``VHOST_USER_SET_VRING_CALL``
275 * ``VHOST_USER_SET_VRING_ERR``
276 * ``VHOST_USER_SET_SLAVE_REQ_FD``
277 * ``VHOST_USER_SET_INFLIGHT_FD`` (if ``VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD``)
278
279 If *master* is unable to send the full message or receives a wrong
280 reply it will close the connection. An optional reconnection mechanism
281 can be implemented.
282
283 If *slave* detects some error such as incompatible features, it may also
284 close the connection. This should only happen in exceptional circumstances.
285
286 Any protocol extensions are gated by protocol feature bits, which
287 allows full backwards compatibility on both master and slave.  As
288 older slaves don't support negotiating protocol features, a feature
289 bit was dedicated for this purpose::
290
291   #define VHOST_USER_F_PROTOCOL_FEATURES 30
292
293 Starting and stopping rings
294 ---------------------------
295
296 Client must only process each ring when it is started.
297
298 Client must only pass data between the ring and the backend, when the
299 ring is enabled.
300
301 If ring is started but disabled, client must process the ring without
302 talking to the backend.
303
304 For example, for a networking device, in the disabled state client
305 must not supply any new RX packets, but must process and discard any
306 TX packets.
307
308 If ``VHOST_USER_F_PROTOCOL_FEATURES`` has not been negotiated, the
309 ring is initialized in an enabled state.
310
311 If ``VHOST_USER_F_PROTOCOL_FEATURES`` has been negotiated, the ring is
312 initialized in a disabled state. Client must not pass data to/from the
313 backend until ring is enabled by ``VHOST_USER_SET_VRING_ENABLE`` with
314 parameter 1, or after it has been disabled by
315 ``VHOST_USER_SET_VRING_ENABLE`` with parameter 0.
316
317 Each ring is initialized in a stopped state, client must not process
318 it until ring is started, or after it has been stopped.
319
320 Client must start ring upon receiving a kick (that is, detecting that
321 file descriptor is readable) on the descriptor specified by
322 ``VHOST_USER_SET_VRING_KICK`` or receiving the in-band message
323 ``VHOST_USER_VRING_KICK`` if negotiated, and stop ring upon receiving
324 ``VHOST_USER_GET_VRING_BASE``.
325
326 While processing the rings (whether they are enabled or not), client
327 must support changing some configuration aspects on the fly.
328
329 Multiple queue support
330 ----------------------
331
332 Many devices have a fixed number of virtqueues.  In this case the master
333 already knows the number of available virtqueues without communicating with the
334 slave.
335
336 Some devices do not have a fixed number of virtqueues.  Instead the maximum
337 number of virtqueues is chosen by the slave.  The number can depend on host
338 resource availability or slave implementation details.  Such devices are called
339 multiple queue devices.
340
341 Multiple queue support allows the slave to advertise the maximum number of
342 queues.  This is treated as a protocol extension, hence the slave has to
343 implement protocol features first. The multiple queues feature is supported
344 only when the protocol feature ``VHOST_USER_PROTOCOL_F_MQ`` (bit 0) is set.
345
346 The max number of queues the slave supports can be queried with message
347 ``VHOST_USER_GET_QUEUE_NUM``. Master should stop when the number of requested
348 queues is bigger than that.
349
350 As all queues share one connection, the master uses a unique index for each
351 queue in the sent message to identify a specified queue.
352
353 The master enables queues by sending message ``VHOST_USER_SET_VRING_ENABLE``.
354 vhost-user-net has historically automatically enabled the first queue pair.
355
356 Slaves should always implement the ``VHOST_USER_PROTOCOL_F_MQ`` protocol
357 feature, even for devices with a fixed number of virtqueues, since it is simple
358 to implement and offers a degree of introspection.
359
360 Masters must not rely on the ``VHOST_USER_PROTOCOL_F_MQ`` protocol feature for
361 devices with a fixed number of virtqueues.  Only true multiqueue devices
362 require this protocol feature.
363
364 Migration
365 ---------
366
367 During live migration, the master may need to track the modifications
368 the slave makes to the memory mapped regions. The client should mark
369 the dirty pages in a log. Once it complies to this logging, it may
370 declare the ``VHOST_F_LOG_ALL`` vhost feature.
371
372 To start/stop logging of data/used ring writes, server may send
373 messages ``VHOST_USER_SET_FEATURES`` with ``VHOST_F_LOG_ALL`` and
374 ``VHOST_USER_SET_VRING_ADDR`` with ``VHOST_VRING_F_LOG`` in ring's
375 flags set to 1/0, respectively.
376
377 All the modifications to memory pointed by vring "descriptor" should
378 be marked. Modifications to "used" vring should be marked if
379 ``VHOST_VRING_F_LOG`` is part of ring's flags.
380
381 Dirty pages are of size::
382
383   #define VHOST_LOG_PAGE 0x1000
384
385 The log memory fd is provided in the ancillary data of
386 ``VHOST_USER_SET_LOG_BASE`` message when the slave has
387 ``VHOST_USER_PROTOCOL_F_LOG_SHMFD`` protocol feature.
388
389 The size of the log is supplied as part of ``VhostUserMsg`` which
390 should be large enough to cover all known guest addresses. Log starts
391 at the supplied offset in the supplied file descriptor.  The log
392 covers from address 0 to the maximum of guest regions. In pseudo-code,
393 to mark page at ``addr`` as dirty::
394
395   page = addr / VHOST_LOG_PAGE
396   log[page / 8] |= 1 << page % 8
397
398 Where ``addr`` is the guest physical address.
399
400 Use atomic operations, as the log may be concurrently manipulated.
401
402 Note that when logging modifications to the used ring (when
403 ``VHOST_VRING_F_LOG`` is set for this ring), ``log_guest_addr`` should
404 be used to calculate the log offset: the write to first byte of the
405 used ring is logged at this offset from log start. Also note that this
406 value might be outside the legal guest physical address range
407 (i.e. does not have to be covered by the ``VhostUserMemory`` table), but
408 the bit offset of the last byte of the ring must fall within the size
409 supplied by ``VhostUserLog``.
410
411 ``VHOST_USER_SET_LOG_FD`` is an optional message with an eventfd in
412 ancillary data, it may be used to inform the master that the log has
413 been modified.
414
415 Once the source has finished migration, rings will be stopped by the
416 source. No further update must be done before rings are restarted.
417
418 In postcopy migration the slave is started before all the memory has
419 been received from the source host, and care must be taken to avoid
420 accessing pages that have yet to be received.  The slave opens a
421 'userfault'-fd and registers the memory with it; this fd is then
422 passed back over to the master.  The master services requests on the
423 userfaultfd for pages that are accessed and when the page is available
424 it performs WAKE ioctl's on the userfaultfd to wake the stalled
425 slave.  The client indicates support for this via the
426 ``VHOST_USER_PROTOCOL_F_PAGEFAULT`` feature.
427
428 Memory access
429 -------------
430
431 The master sends a list of vhost memory regions to the slave using the
432 ``VHOST_USER_SET_MEM_TABLE`` message.  Each region has two base
433 addresses: a guest address and a user address.
434
435 Messages contain guest addresses and/or user addresses to reference locations
436 within the shared memory.  The mapping of these addresses works as follows.
437
438 User addresses map to the vhost memory region containing that user address.
439
440 When the ``VIRTIO_F_IOMMU_PLATFORM`` feature has not been negotiated:
441
442 * Guest addresses map to the vhost memory region containing that guest
443   address.
444
445 When the ``VIRTIO_F_IOMMU_PLATFORM`` feature has been negotiated:
446
447 * Guest addresses are also called I/O virtual addresses (IOVAs).  They are
448   translated to user addresses via the IOTLB.
449
450 * The vhost memory region guest address is not used.
451
452 IOMMU support
453 -------------
454
455 When the ``VIRTIO_F_IOMMU_PLATFORM`` feature has been negotiated, the
456 master sends IOTLB entries update & invalidation by sending
457 ``VHOST_USER_IOTLB_MSG`` requests to the slave with a ``struct
458 vhost_iotlb_msg`` as payload. For update events, the ``iotlb`` payload
459 has to be filled with the update message type (2), the I/O virtual
460 address, the size, the user virtual address, and the permissions
461 flags. Addresses and size must be within vhost memory regions set via
462 the ``VHOST_USER_SET_MEM_TABLE`` request. For invalidation events, the
463 ``iotlb`` payload has to be filled with the invalidation message type
464 (3), the I/O virtual address and the size. On success, the slave is
465 expected to reply with a zero payload, non-zero otherwise.
466
467 The slave relies on the slave communcation channel (see :ref:`Slave
468 communication <slave_communication>` section below) to send IOTLB miss
469 and access failure events, by sending ``VHOST_USER_SLAVE_IOTLB_MSG``
470 requests to the master with a ``struct vhost_iotlb_msg`` as
471 payload. For miss events, the iotlb payload has to be filled with the
472 miss message type (1), the I/O virtual address and the permissions
473 flags. For access failure event, the iotlb payload has to be filled
474 with the access failure message type (4), the I/O virtual address and
475 the permissions flags.  For synchronization purpose, the slave may
476 rely on the reply-ack feature, so the master may send a reply when
477 operation is completed if the reply-ack feature is negotiated and
478 slaves requests a reply. For miss events, completed operation means
479 either master sent an update message containing the IOTLB entry
480 containing requested address and permission, or master sent nothing if
481 the IOTLB miss message is invalid (invalid IOVA or permission).
482
483 The master isn't expected to take the initiative to send IOTLB update
484 messages, as the slave sends IOTLB miss messages for the guest virtual
485 memory areas it needs to access.
486
487 .. _slave_communication:
488
489 Slave communication
490 -------------------
491
492 An optional communication channel is provided if the slave declares
493 ``VHOST_USER_PROTOCOL_F_SLAVE_REQ`` protocol feature, to allow the
494 slave to make requests to the master.
495
496 The fd is provided via ``VHOST_USER_SET_SLAVE_REQ_FD`` ancillary data.
497
498 A slave may then send ``VHOST_USER_SLAVE_*`` messages to the master
499 using this fd communication channel.
500
501 If ``VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD`` protocol feature is
502 negotiated, slave can send file descriptors (at most 8 descriptors in
503 each message) to master via ancillary data using this fd communication
504 channel.
505
506 Inflight I/O tracking
507 ---------------------
508
509 To support reconnecting after restart or crash, slave may need to
510 resubmit inflight I/Os. If virtqueue is processed in order, we can
511 easily achieve that by getting the inflight descriptors from
512 descriptor table (split virtqueue) or descriptor ring (packed
513 virtqueue). However, it can't work when we process descriptors
514 out-of-order because some entries which store the information of
515 inflight descriptors in available ring (split virtqueue) or descriptor
516 ring (packed virtqueue) might be overrided by new entries. To solve
517 this problem, slave need to allocate an extra buffer to store this
518 information of inflight descriptors and share it with master for
519 persistent. ``VHOST_USER_GET_INFLIGHT_FD`` and
520 ``VHOST_USER_SET_INFLIGHT_FD`` are used to transfer this buffer
521 between master and slave. And the format of this buffer is described
522 below:
523
524 +---------------+---------------+-----+---------------+
525 | queue0 region | queue1 region | ... | queueN region |
526 +---------------+---------------+-----+---------------+
527
528 N is the number of available virtqueues. Slave could get it from num
529 queues field of ``VhostUserInflight``.
530
531 For split virtqueue, queue region can be implemented as:
532
533 .. code:: c
534
535   typedef struct DescStateSplit {
536       /* Indicate whether this descriptor is inflight or not.
537        * Only available for head-descriptor. */
538       uint8_t inflight;
539
540       /* Padding */
541       uint8_t padding[5];
542
543       /* Maintain a list for the last batch of used descriptors.
544        * Only available when batching is used for submitting */
545       uint16_t next;
546
547       /* Used to preserve the order of fetching available descriptors.
548        * Only available for head-descriptor. */
549       uint64_t counter;
550   } DescStateSplit;
551
552   typedef struct QueueRegionSplit {
553       /* The feature flags of this region. Now it's initialized to 0. */
554       uint64_t features;
555
556       /* The version of this region. It's 1 currently.
557        * Zero value indicates an uninitialized buffer */
558       uint16_t version;
559
560       /* The size of DescStateSplit array. It's equal to the virtqueue
561        * size. Slave could get it from queue size field of VhostUserInflight. */
562       uint16_t desc_num;
563
564       /* The head of list that track the last batch of used descriptors. */
565       uint16_t last_batch_head;
566
567       /* Store the idx value of used ring */
568       uint16_t used_idx;
569
570       /* Used to track the state of each descriptor in descriptor table */
571       DescStateSplit desc[];
572   } QueueRegionSplit;
573
574 To track inflight I/O, the queue region should be processed as follows:
575
576 When receiving available buffers from the driver:
577
578 #. Get the next available head-descriptor index from available ring, ``i``
579
580 #. Set ``desc[i].counter`` to the value of global counter
581
582 #. Increase global counter by 1
583
584 #. Set ``desc[i].inflight`` to 1
585
586 When supplying used buffers to the driver:
587
588 1. Get corresponding used head-descriptor index, i
589
590 2. Set ``desc[i].next`` to ``last_batch_head``
591
592 3. Set ``last_batch_head`` to ``i``
593
594 #. Steps 1,2,3 may be performed repeatedly if batching is possible
595
596 #. Increase the ``idx`` value of used ring by the size of the batch
597
598 #. Set the ``inflight`` field of each ``DescStateSplit`` entry in the batch to 0
599
600 #. Set ``used_idx`` to the ``idx`` value of used ring
601
602 When reconnecting:
603
604 #. If the value of ``used_idx`` does not match the ``idx`` value of
605    used ring (means the inflight field of ``DescStateSplit`` entries in
606    last batch may be incorrect),
607
608    a. Subtract the value of ``used_idx`` from the ``idx`` value of
609       used ring to get last batch size of ``DescStateSplit`` entries
610
611    #. Set the ``inflight`` field of each ``DescStateSplit`` entry to 0 in last batch
612       list which starts from ``last_batch_head``
613
614    #. Set ``used_idx`` to the ``idx`` value of used ring
615
616 #. Resubmit inflight ``DescStateSplit`` entries in order of their
617    counter value
618
619 For packed virtqueue, queue region can be implemented as:
620
621 .. code:: c
622
623   typedef struct DescStatePacked {
624       /* Indicate whether this descriptor is inflight or not.
625        * Only available for head-descriptor. */
626       uint8_t inflight;
627
628       /* Padding */
629       uint8_t padding;
630
631       /* Link to the next free entry */
632       uint16_t next;
633
634       /* Link to the last entry of descriptor list.
635        * Only available for head-descriptor. */
636       uint16_t last;
637
638       /* The length of descriptor list.
639        * Only available for head-descriptor. */
640       uint16_t num;
641
642       /* Used to preserve the order of fetching available descriptors.
643        * Only available for head-descriptor. */
644       uint64_t counter;
645
646       /* The buffer id */
647       uint16_t id;
648
649       /* The descriptor flags */
650       uint16_t flags;
651
652       /* The buffer length */
653       uint32_t len;
654
655       /* The buffer address */
656       uint64_t addr;
657   } DescStatePacked;
658
659   typedef struct QueueRegionPacked {
660       /* The feature flags of this region. Now it's initialized to 0. */
661       uint64_t features;
662
663       /* The version of this region. It's 1 currently.
664        * Zero value indicates an uninitialized buffer */
665       uint16_t version;
666
667       /* The size of DescStatePacked array. It's equal to the virtqueue
668        * size. Slave could get it from queue size field of VhostUserInflight. */
669       uint16_t desc_num;
670
671       /* The head of free DescStatePacked entry list */
672       uint16_t free_head;
673
674       /* The old head of free DescStatePacked entry list */
675       uint16_t old_free_head;
676
677       /* The used index of descriptor ring */
678       uint16_t used_idx;
679
680       /* The old used index of descriptor ring */
681       uint16_t old_used_idx;
682
683       /* Device ring wrap counter */
684       uint8_t used_wrap_counter;
685
686       /* The old device ring wrap counter */
687       uint8_t old_used_wrap_counter;
688
689       /* Padding */
690       uint8_t padding[7];
691
692       /* Used to track the state of each descriptor fetched from descriptor ring */
693       DescStatePacked desc[];
694   } QueueRegionPacked;
695
696 To track inflight I/O, the queue region should be processed as follows:
697
698 When receiving available buffers from the driver:
699
700 #. Get the next available descriptor entry from descriptor ring, ``d``
701
702 #. If ``d`` is head descriptor,
703
704    a. Set ``desc[old_free_head].num`` to 0
705
706    #. Set ``desc[old_free_head].counter`` to the value of global counter
707
708    #. Increase global counter by 1
709
710    #. Set ``desc[old_free_head].inflight`` to 1
711
712 #. If ``d`` is last descriptor, set ``desc[old_free_head].last`` to
713    ``free_head``
714
715 #. Increase ``desc[old_free_head].num`` by 1
716
717 #. Set ``desc[free_head].addr``, ``desc[free_head].len``,
718    ``desc[free_head].flags``, ``desc[free_head].id`` to ``d.addr``,
719    ``d.len``, ``d.flags``, ``d.id``
720
721 #. Set ``free_head`` to ``desc[free_head].next``
722
723 #. If ``d`` is last descriptor, set ``old_free_head`` to ``free_head``
724
725 When supplying used buffers to the driver:
726
727 1. Get corresponding used head-descriptor entry from descriptor ring,
728    ``d``
729
730 2. Get corresponding ``DescStatePacked`` entry, ``e``
731
732 3. Set ``desc[e.last].next`` to ``free_head``
733
734 4. Set ``free_head`` to the index of ``e``
735
736 #. Steps 1,2,3,4 may be performed repeatedly if batching is possible
737
738 #. Increase ``used_idx`` by the size of the batch and update
739    ``used_wrap_counter`` if needed
740
741 #. Update ``d.flags``
742
743 #. Set the ``inflight`` field of each head ``DescStatePacked`` entry
744    in the batch to 0
745
746 #. Set ``old_free_head``,  ``old_used_idx``, ``old_used_wrap_counter``
747    to ``free_head``, ``used_idx``, ``used_wrap_counter``
748
749 When reconnecting:
750
751 #. If ``used_idx`` does not match ``old_used_idx`` (means the
752    ``inflight`` field of ``DescStatePacked`` entries in last batch may
753    be incorrect),
754
755    a. Get the next descriptor ring entry through ``old_used_idx``, ``d``
756
757    #. Use ``old_used_wrap_counter`` to calculate the available flags
758
759    #. If ``d.flags`` is not equal to the calculated flags value (means
760       slave has submitted the buffer to guest driver before crash, so
761       it has to commit the in-progres update), set ``old_free_head``,
762       ``old_used_idx``, ``old_used_wrap_counter`` to ``free_head``,
763       ``used_idx``, ``used_wrap_counter``
764
765 #. Set ``free_head``, ``used_idx``, ``used_wrap_counter`` to
766    ``old_free_head``, ``old_used_idx``, ``old_used_wrap_counter``
767    (roll back any in-progress update)
768
769 #. Set the ``inflight`` field of each ``DescStatePacked`` entry in
770    free list to 0
771
772 #. Resubmit inflight ``DescStatePacked`` entries in order of their
773    counter value
774
775 In-band notifications
776 ---------------------
777
778 In some limited situations (e.g. for simulation) it is desirable to
779 have the kick, call and error (if used) signals done via in-band
780 messages instead of asynchronous eventfd notifications. This can be
781 done by negotiating the ``VHOST_USER_PROTOCOL_F_INBAND_NOTIFICATIONS``
782 protocol feature.
783
784 Note that due to the fact that too many messages on the sockets can
785 cause the sending application(s) to block, it is not advised to use
786 this feature unless absolutely necessary. It is also considered an
787 error to negotiate this feature without also negotiating
788 ``VHOST_USER_PROTOCOL_F_SLAVE_REQ`` and ``VHOST_USER_PROTOCOL_F_REPLY_ACK``,
789 the former is necessary for getting a message channel from the slave
790 to the master, while the latter needs to be used with the in-band
791 notification messages to block until they are processed, both to avoid
792 blocking later and for proper processing (at least in the simulation
793 use case.) As it has no other way of signalling this error, the slave
794 should close the connection as a response to a
795 ``VHOST_USER_SET_PROTOCOL_FEATURES`` message that sets the in-band
796 notifications feature flag without the other two.
797
798 Protocol features
799 -----------------
800
801 .. code:: c
802
803   #define VHOST_USER_PROTOCOL_F_MQ                    0
804   #define VHOST_USER_PROTOCOL_F_LOG_SHMFD             1
805   #define VHOST_USER_PROTOCOL_F_RARP                  2
806   #define VHOST_USER_PROTOCOL_F_REPLY_ACK             3
807   #define VHOST_USER_PROTOCOL_F_MTU                   4
808   #define VHOST_USER_PROTOCOL_F_SLAVE_REQ             5
809   #define VHOST_USER_PROTOCOL_F_CROSS_ENDIAN          6
810   #define VHOST_USER_PROTOCOL_F_CRYPTO_SESSION        7
811   #define VHOST_USER_PROTOCOL_F_PAGEFAULT             8
812   #define VHOST_USER_PROTOCOL_F_CONFIG                9
813   #define VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD        10
814   #define VHOST_USER_PROTOCOL_F_HOST_NOTIFIER        11
815   #define VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD       12
816   #define VHOST_USER_PROTOCOL_F_RESET_DEVICE         13
817   #define VHOST_USER_PROTOCOL_F_INBAND_NOTIFICATIONS 14
818
819 Master message types
820 --------------------
821
822 ``VHOST_USER_GET_FEATURES``
823   :id: 1
824   :equivalent ioctl: ``VHOST_GET_FEATURES``
825   :master payload: N/A
826   :slave payload: ``u64``
827
828   Get from the underlying vhost implementation the features bitmask.
829   Feature bit ``VHOST_USER_F_PROTOCOL_FEATURES`` signals slave support
830   for ``VHOST_USER_GET_PROTOCOL_FEATURES`` and
831   ``VHOST_USER_SET_PROTOCOL_FEATURES``.
832
833 ``VHOST_USER_SET_FEATURES``
834   :id: 2
835   :equivalent ioctl: ``VHOST_SET_FEATURES``
836   :master payload: ``u64``
837
838   Enable features in the underlying vhost implementation using a
839   bitmask.  Feature bit ``VHOST_USER_F_PROTOCOL_FEATURES`` signals
840   slave support for ``VHOST_USER_GET_PROTOCOL_FEATURES`` and
841   ``VHOST_USER_SET_PROTOCOL_FEATURES``.
842
843 ``VHOST_USER_GET_PROTOCOL_FEATURES``
844   :id: 15
845   :equivalent ioctl: ``VHOST_GET_FEATURES``
846   :master payload: N/A
847   :slave payload: ``u64``
848
849   Get the protocol feature bitmask from the underlying vhost
850   implementation.  Only legal if feature bit
851   ``VHOST_USER_F_PROTOCOL_FEATURES`` is present in
852   ``VHOST_USER_GET_FEATURES``.
853
854 .. Note::
855    Slave that reported ``VHOST_USER_F_PROTOCOL_FEATURES`` must
856    support this message even before ``VHOST_USER_SET_FEATURES`` was
857    called.
858
859 ``VHOST_USER_SET_PROTOCOL_FEATURES``
860   :id: 16
861   :equivalent ioctl: ``VHOST_SET_FEATURES``
862   :master payload: ``u64``
863
864   Enable protocol features in the underlying vhost implementation.
865
866   Only legal if feature bit ``VHOST_USER_F_PROTOCOL_FEATURES`` is present in
867   ``VHOST_USER_GET_FEATURES``.
868
869 .. Note::
870    Slave that reported ``VHOST_USER_F_PROTOCOL_FEATURES`` must support
871    this message even before ``VHOST_USER_SET_FEATURES`` was called.
872
873 ``VHOST_USER_SET_OWNER``
874   :id: 3
875   :equivalent ioctl: ``VHOST_SET_OWNER``
876   :master payload: N/A
877
878   Issued when a new connection is established. It sets the current
879   *master* as an owner of the session. This can be used on the *slave*
880   as a "session start" flag.
881
882 ``VHOST_USER_RESET_OWNER``
883   :id: 4
884   :master payload: N/A
885
886 .. admonition:: Deprecated
887
888    This is no longer used. Used to be sent to request disabling all
889    rings, but some clients interpreted it to also discard connection
890    state (this interpretation would lead to bugs).  It is recommended
891    that clients either ignore this message, or use it to disable all
892    rings.
893
894 ``VHOST_USER_SET_MEM_TABLE``
895   :id: 5
896   :equivalent ioctl: ``VHOST_SET_MEM_TABLE``
897   :master payload: memory regions description
898   :slave payload: (postcopy only) memory regions description
899
900   Sets the memory map regions on the slave so it can translate the
901   vring addresses. In the ancillary data there is an array of file
902   descriptors for each memory mapped region. The size and ordering of
903   the fds matches the number and ordering of memory regions.
904
905   When ``VHOST_USER_POSTCOPY_LISTEN`` has been received,
906   ``SET_MEM_TABLE`` replies with the bases of the memory mapped
907   regions to the master.  The slave must have mmap'd the regions but
908   not yet accessed them and should not yet generate a userfault
909   event.
910
911 .. Note::
912    ``NEED_REPLY_MASK`` is not set in this case.  QEMU will then
913    reply back to the list of mappings with an empty
914    ``VHOST_USER_SET_MEM_TABLE`` as an acknowledgement; only upon
915    reception of this message may the guest start accessing the memory
916    and generating faults.
917
918 ``VHOST_USER_SET_LOG_BASE``
919   :id: 6
920   :equivalent ioctl: ``VHOST_SET_LOG_BASE``
921   :master payload: u64
922   :slave payload: N/A
923
924   Sets logging shared memory space.
925
926   When slave has ``VHOST_USER_PROTOCOL_F_LOG_SHMFD`` protocol feature,
927   the log memory fd is provided in the ancillary data of
928   ``VHOST_USER_SET_LOG_BASE`` message, the size and offset of shared
929   memory area provided in the message.
930
931 ``VHOST_USER_SET_LOG_FD``
932   :id: 7
933   :equivalent ioctl: ``VHOST_SET_LOG_FD``
934   :master payload: N/A
935
936   Sets the logging file descriptor, which is passed as ancillary data.
937
938 ``VHOST_USER_SET_VRING_NUM``
939   :id: 8
940   :equivalent ioctl: ``VHOST_SET_VRING_NUM``
941   :master payload: vring state description
942
943   Set the size of the queue.
944
945 ``VHOST_USER_SET_VRING_ADDR``
946   :id: 9
947   :equivalent ioctl: ``VHOST_SET_VRING_ADDR``
948   :master payload: vring address description
949   :slave payload: N/A
950
951   Sets the addresses of the different aspects of the vring.
952
953 ``VHOST_USER_SET_VRING_BASE``
954   :id: 10
955   :equivalent ioctl: ``VHOST_SET_VRING_BASE``
956   :master payload: vring state description
957
958   Sets the base offset in the available vring.
959
960 ``VHOST_USER_GET_VRING_BASE``
961   :id: 11
962   :equivalent ioctl: ``VHOST_USER_GET_VRING_BASE``
963   :master payload: vring state description
964   :slave payload: vring state description
965
966   Get the available vring base offset.
967
968 ``VHOST_USER_SET_VRING_KICK``
969   :id: 12
970   :equivalent ioctl: ``VHOST_SET_VRING_KICK``
971   :master payload: ``u64``
972
973   Set the event file descriptor for adding buffers to the vring. It is
974   passed in the ancillary data.
975
976   Bits (0-7) of the payload contain the vring index. Bit 8 is the
977   invalid FD flag. This flag is set when there is no file descriptor
978   in the ancillary data. This signals that polling should be used
979   instead of waiting for the kick. Note that if the protocol feature
980   ``VHOST_USER_PROTOCOL_F_INBAND_NOTIFICATIONS`` has been negotiated
981   this message isn't necessary as the ring is also started on the
982   ``VHOST_USER_VRING_KICK`` message, it may however still be used to
983   set an event file descriptor (which will be preferred over the
984   message) or to enable polling.
985
986 ``VHOST_USER_SET_VRING_CALL``
987   :id: 13
988   :equivalent ioctl: ``VHOST_SET_VRING_CALL``
989   :master payload: ``u64``
990
991   Set the event file descriptor to signal when buffers are used. It is
992   passed in the ancillary data.
993
994   Bits (0-7) of the payload contain the vring index. Bit 8 is the
995   invalid FD flag. This flag is set when there is no file descriptor
996   in the ancillary data. This signals that polling will be used
997   instead of waiting for the call. Note that if the protocol features
998   ``VHOST_USER_PROTOCOL_F_INBAND_NOTIFICATIONS`` and
999   ``VHOST_USER_PROTOCOL_F_SLAVE_REQ`` have been negotiated this message
1000   isn't necessary as the ``VHOST_USER_SLAVE_VRING_CALL`` message can be
1001   used, it may however still be used to set an event file descriptor
1002   or to enable polling.
1003
1004 ``VHOST_USER_SET_VRING_ERR``
1005   :id: 14
1006   :equivalent ioctl: ``VHOST_SET_VRING_ERR``
1007   :master payload: ``u64``
1008
1009   Set the event file descriptor to signal when error occurs. It is
1010   passed in the ancillary data.
1011
1012   Bits (0-7) of the payload contain the vring index. Bit 8 is the
1013   invalid FD flag. This flag is set when there is no file descriptor
1014   in the ancillary data. Note that if the protocol features
1015   ``VHOST_USER_PROTOCOL_F_INBAND_NOTIFICATIONS`` and
1016   ``VHOST_USER_PROTOCOL_F_SLAVE_REQ`` have been negotiated this message
1017   isn't necessary as the ``VHOST_USER_SLAVE_VRING_ERR`` message can be
1018   used, it may however still be used to set an event file descriptor
1019   (which will be preferred over the message).
1020
1021 ``VHOST_USER_GET_QUEUE_NUM``
1022   :id: 17
1023   :equivalent ioctl: N/A
1024   :master payload: N/A
1025   :slave payload: u64
1026
1027   Query how many queues the backend supports.
1028
1029   This request should be sent only when ``VHOST_USER_PROTOCOL_F_MQ``
1030   is set in queried protocol features by
1031   ``VHOST_USER_GET_PROTOCOL_FEATURES``.
1032
1033 ``VHOST_USER_SET_VRING_ENABLE``
1034   :id: 18
1035   :equivalent ioctl: N/A
1036   :master payload: vring state description
1037
1038   Signal slave to enable or disable corresponding vring.
1039
1040   This request should be sent only when
1041   ``VHOST_USER_F_PROTOCOL_FEATURES`` has been negotiated.
1042
1043 ``VHOST_USER_SEND_RARP``
1044   :id: 19
1045   :equivalent ioctl: N/A
1046   :master payload: ``u64``
1047
1048   Ask vhost user backend to broadcast a fake RARP to notify the migration
1049   is terminated for guest that does not support GUEST_ANNOUNCE.
1050
1051   Only legal if feature bit ``VHOST_USER_F_PROTOCOL_FEATURES`` is
1052   present in ``VHOST_USER_GET_FEATURES`` and protocol feature bit
1053   ``VHOST_USER_PROTOCOL_F_RARP`` is present in
1054   ``VHOST_USER_GET_PROTOCOL_FEATURES``.  The first 6 bytes of the
1055   payload contain the mac address of the guest to allow the vhost user
1056   backend to construct and broadcast the fake RARP.
1057
1058 ``VHOST_USER_NET_SET_MTU``
1059   :id: 20
1060   :equivalent ioctl: N/A
1061   :master payload: ``u64``
1062
1063   Set host MTU value exposed to the guest.
1064
1065   This request should be sent only when ``VIRTIO_NET_F_MTU`` feature
1066   has been successfully negotiated, ``VHOST_USER_F_PROTOCOL_FEATURES``
1067   is present in ``VHOST_USER_GET_FEATURES`` and protocol feature bit
1068   ``VHOST_USER_PROTOCOL_F_NET_MTU`` is present in
1069   ``VHOST_USER_GET_PROTOCOL_FEATURES``.
1070
1071   If ``VHOST_USER_PROTOCOL_F_REPLY_ACK`` is negotiated, slave must
1072   respond with zero in case the specified MTU is valid, or non-zero
1073   otherwise.
1074
1075 ``VHOST_USER_SET_SLAVE_REQ_FD``
1076   :id: 21
1077   :equivalent ioctl: N/A
1078   :master payload: N/A
1079
1080   Set the socket file descriptor for slave initiated requests. It is passed
1081   in the ancillary data.
1082
1083   This request should be sent only when
1084   ``VHOST_USER_F_PROTOCOL_FEATURES`` has been negotiated, and protocol
1085   feature bit ``VHOST_USER_PROTOCOL_F_SLAVE_REQ`` bit is present in
1086   ``VHOST_USER_GET_PROTOCOL_FEATURES``.  If
1087   ``VHOST_USER_PROTOCOL_F_REPLY_ACK`` is negotiated, slave must
1088   respond with zero for success, non-zero otherwise.
1089
1090 ``VHOST_USER_IOTLB_MSG``
1091   :id: 22
1092   :equivalent ioctl: N/A (equivalent to ``VHOST_IOTLB_MSG`` message type)
1093   :master payload: ``struct vhost_iotlb_msg``
1094   :slave payload: ``u64``
1095
1096   Send IOTLB messages with ``struct vhost_iotlb_msg`` as payload.
1097
1098   Master sends such requests to update and invalidate entries in the
1099   device IOTLB. The slave has to acknowledge the request with sending
1100   zero as ``u64`` payload for success, non-zero otherwise.
1101
1102   This request should be send only when ``VIRTIO_F_IOMMU_PLATFORM``
1103   feature has been successfully negotiated.
1104
1105 ``VHOST_USER_SET_VRING_ENDIAN``
1106   :id: 23
1107   :equivalent ioctl: ``VHOST_SET_VRING_ENDIAN``
1108   :master payload: vring state description
1109
1110   Set the endianness of a VQ for legacy devices. Little-endian is
1111   indicated with state.num set to 0 and big-endian is indicated with
1112   state.num set to 1. Other values are invalid.
1113
1114   This request should be sent only when
1115   ``VHOST_USER_PROTOCOL_F_CROSS_ENDIAN`` has been negotiated.
1116   Backends that negotiated this feature should handle both
1117   endiannesses and expect this message once (per VQ) during device
1118   configuration (ie. before the master starts the VQ).
1119
1120 ``VHOST_USER_GET_CONFIG``
1121   :id: 24
1122   :equivalent ioctl: N/A
1123   :master payload: virtio device config space
1124   :slave payload: virtio device config space
1125
1126   When ``VHOST_USER_PROTOCOL_F_CONFIG`` is negotiated, this message is
1127   submitted by the vhost-user master to fetch the contents of the
1128   virtio device configuration space, vhost-user slave's payload size
1129   MUST match master's request, vhost-user slave uses zero length of
1130   payload to indicate an error to vhost-user master. The vhost-user
1131   master may cache the contents to avoid repeated
1132   ``VHOST_USER_GET_CONFIG`` calls.
1133
1134 ``VHOST_USER_SET_CONFIG``
1135   :id: 25
1136   :equivalent ioctl: N/A
1137   :master payload: virtio device config space
1138   :slave payload: N/A
1139
1140   When ``VHOST_USER_PROTOCOL_F_CONFIG`` is negotiated, this message is
1141   submitted by the vhost-user master when the Guest changes the virtio
1142   device configuration space and also can be used for live migration
1143   on the destination host. The vhost-user slave must check the flags
1144   field, and slaves MUST NOT accept SET_CONFIG for read-only
1145   configuration space fields unless the live migration bit is set.
1146
1147 ``VHOST_USER_CREATE_CRYPTO_SESSION``
1148   :id: 26
1149   :equivalent ioctl: N/A
1150   :master payload: crypto session description
1151   :slave payload: crypto session description
1152
1153   Create a session for crypto operation. The server side must return
1154   the session id, 0 or positive for success, negative for failure.
1155   This request should be sent only when
1156   ``VHOST_USER_PROTOCOL_F_CRYPTO_SESSION`` feature has been
1157   successfully negotiated.  It's a required feature for crypto
1158   devices.
1159
1160 ``VHOST_USER_CLOSE_CRYPTO_SESSION``
1161   :id: 27
1162   :equivalent ioctl: N/A
1163   :master payload: ``u64``
1164
1165   Close a session for crypto operation which was previously
1166   created by ``VHOST_USER_CREATE_CRYPTO_SESSION``.
1167
1168   This request should be sent only when
1169   ``VHOST_USER_PROTOCOL_F_CRYPTO_SESSION`` feature has been
1170   successfully negotiated.  It's a required feature for crypto
1171   devices.
1172
1173 ``VHOST_USER_POSTCOPY_ADVISE``
1174   :id: 28
1175   :master payload: N/A
1176   :slave payload: userfault fd
1177
1178   When ``VHOST_USER_PROTOCOL_F_PAGEFAULT`` is supported, the master
1179   advises slave that a migration with postcopy enabled is underway,
1180   the slave must open a userfaultfd for later use.  Note that at this
1181   stage the migration is still in precopy mode.
1182
1183 ``VHOST_USER_POSTCOPY_LISTEN``
1184   :id: 29
1185   :master payload: N/A
1186
1187   Master advises slave that a transition to postcopy mode has
1188   happened.  The slave must ensure that shared memory is registered
1189   with userfaultfd to cause faulting of non-present pages.
1190
1191   This is always sent sometime after a ``VHOST_USER_POSTCOPY_ADVISE``,
1192   and thus only when ``VHOST_USER_PROTOCOL_F_PAGEFAULT`` is supported.
1193
1194 ``VHOST_USER_POSTCOPY_END``
1195   :id: 30
1196   :slave payload: ``u64``
1197
1198   Master advises that postcopy migration has now completed.  The slave
1199   must disable the userfaultfd. The response is an acknowledgement
1200   only.
1201
1202   When ``VHOST_USER_PROTOCOL_F_PAGEFAULT`` is supported, this message
1203   is sent at the end of the migration, after
1204   ``VHOST_USER_POSTCOPY_LISTEN`` was previously sent.
1205
1206   The value returned is an error indication; 0 is success.
1207
1208 ``VHOST_USER_GET_INFLIGHT_FD``
1209   :id: 31
1210   :equivalent ioctl: N/A
1211   :master payload: inflight description
1212
1213   When ``VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD`` protocol feature has
1214   been successfully negotiated, this message is submitted by master to
1215   get a shared buffer from slave. The shared buffer will be used to
1216   track inflight I/O by slave. QEMU should retrieve a new one when vm
1217   reset.
1218
1219 ``VHOST_USER_SET_INFLIGHT_FD``
1220   :id: 32
1221   :equivalent ioctl: N/A
1222   :master payload: inflight description
1223
1224   When ``VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD`` protocol feature has
1225   been successfully negotiated, this message is submitted by master to
1226   send the shared inflight buffer back to slave so that slave could
1227   get inflight I/O after a crash or restart.
1228
1229 ``VHOST_USER_GPU_SET_SOCKET``
1230   :id: 33
1231   :equivalent ioctl: N/A
1232   :master payload: N/A
1233
1234   Sets the GPU protocol socket file descriptor, which is passed as
1235   ancillary data. The GPU protocol is used to inform the master of
1236   rendering state and updates. See vhost-user-gpu.rst for details.
1237
1238 ``VHOST_USER_RESET_DEVICE``
1239   :id: 34
1240   :equivalent ioctl: N/A
1241   :master payload: N/A
1242   :slave payload: N/A
1243
1244   Ask the vhost user backend to disable all rings and reset all
1245   internal device state to the initial state, ready to be
1246   reinitialized. The backend retains ownership of the device
1247   throughout the reset operation.
1248
1249   Only valid if the ``VHOST_USER_PROTOCOL_F_RESET_DEVICE`` protocol
1250   feature is set by the backend.
1251
1252 ``VHOST_USER_VRING_KICK``
1253   :id: 35
1254   :equivalent ioctl: N/A
1255   :slave payload: vring state description
1256   :master payload: N/A
1257
1258   When the ``VHOST_USER_PROTOCOL_F_INBAND_NOTIFICATIONS`` protocol
1259   feature has been successfully negotiated, this message may be
1260   submitted by the master to indicate that a buffer was added to
1261   the vring instead of signalling it using the vring's kick file
1262   descriptor or having the slave rely on polling.
1263
1264   The state.num field is currently reserved and must be set to 0.
1265
1266 Slave message types
1267 -------------------
1268
1269 ``VHOST_USER_SLAVE_IOTLB_MSG``
1270   :id: 1
1271   :equivalent ioctl: N/A (equivalent to ``VHOST_IOTLB_MSG`` message type)
1272   :slave payload: ``struct vhost_iotlb_msg``
1273   :master payload: N/A
1274
1275   Send IOTLB messages with ``struct vhost_iotlb_msg`` as payload.
1276   Slave sends such requests to notify of an IOTLB miss, or an IOTLB
1277   access failure. If ``VHOST_USER_PROTOCOL_F_REPLY_ACK`` is
1278   negotiated, and slave set the ``VHOST_USER_NEED_REPLY`` flag, master
1279   must respond with zero when operation is successfully completed, or
1280   non-zero otherwise.  This request should be send only when
1281   ``VIRTIO_F_IOMMU_PLATFORM`` feature has been successfully
1282   negotiated.
1283
1284 ``VHOST_USER_SLAVE_CONFIG_CHANGE_MSG``
1285   :id: 2
1286   :equivalent ioctl: N/A
1287   :slave payload: N/A
1288   :master payload: N/A
1289
1290   When ``VHOST_USER_PROTOCOL_F_CONFIG`` is negotiated, vhost-user
1291   slave sends such messages to notify that the virtio device's
1292   configuration space has changed, for those host devices which can
1293   support such feature, host driver can send ``VHOST_USER_GET_CONFIG``
1294   message to slave to get the latest content. If
1295   ``VHOST_USER_PROTOCOL_F_REPLY_ACK`` is negotiated, and slave set the
1296   ``VHOST_USER_NEED_REPLY`` flag, master must respond with zero when
1297   operation is successfully completed, or non-zero otherwise.
1298
1299 ``VHOST_USER_SLAVE_VRING_HOST_NOTIFIER_MSG``
1300   :id: 3
1301   :equivalent ioctl: N/A
1302   :slave payload: vring area description
1303   :master payload: N/A
1304
1305   Sets host notifier for a specified queue. The queue index is
1306   contained in the ``u64`` field of the vring area description. The
1307   host notifier is described by the file descriptor (typically it's a
1308   VFIO device fd) which is passed as ancillary data and the size
1309   (which is mmap size and should be the same as host page size) and
1310   offset (which is mmap offset) carried in the vring area
1311   description. QEMU can mmap the file descriptor based on the size and
1312   offset to get a memory range. Registering a host notifier means
1313   mapping this memory range to the VM as the specified queue's notify
1314   MMIO region. Slave sends this request to tell QEMU to de-register
1315   the existing notifier if any and register the new notifier if the
1316   request is sent with a file descriptor.
1317
1318   This request should be sent only when
1319   ``VHOST_USER_PROTOCOL_F_HOST_NOTIFIER`` protocol feature has been
1320   successfully negotiated.
1321
1322 ``VHOST_USER_SLAVE_VRING_CALL``
1323   :id: 4
1324   :equivalent ioctl: N/A
1325   :slave payload: vring state description
1326   :master payload: N/A
1327
1328   When the ``VHOST_USER_PROTOCOL_F_INBAND_NOTIFICATIONS`` protocol
1329   feature has been successfully negotiated, this message may be
1330   submitted by the slave to indicate that a buffer was used from
1331   the vring instead of signalling this using the vring's call file
1332   descriptor or having the master relying on polling.
1333
1334   The state.num field is currently reserved and must be set to 0.
1335
1336 ``VHOST_USER_SLAVE_VRING_ERR``
1337   :id: 5
1338   :equivalent ioctl: N/A
1339   :slave payload: vring state description
1340   :master payload: N/A
1341
1342   When the ``VHOST_USER_PROTOCOL_F_INBAND_NOTIFICATIONS`` protocol
1343   feature has been successfully negotiated, this message may be
1344   submitted by the slave to indicate that an error occurred on the
1345   specific vring, instead of signalling the error file descriptor
1346   set by the master via ``VHOST_USER_SET_VRING_ERR``.
1347
1348   The state.num field is currently reserved and must be set to 0.
1349
1350 .. _reply_ack:
1351
1352 VHOST_USER_PROTOCOL_F_REPLY_ACK
1353 -------------------------------
1354
1355 The original vhost-user specification only demands replies for certain
1356 commands. This differs from the vhost protocol implementation where
1357 commands are sent over an ``ioctl()`` call and block until the client
1358 has completed.
1359
1360 With this protocol extension negotiated, the sender (QEMU) can set the
1361 ``need_reply`` [Bit 3] flag to any command. This indicates that the
1362 client MUST respond with a Payload ``VhostUserMsg`` indicating success
1363 or failure. The payload should be set to zero on success or non-zero
1364 on failure, unless the message already has an explicit reply body.
1365
1366 The response payload gives QEMU a deterministic indication of the result
1367 of the command. Today, QEMU is expected to terminate the main vhost-user
1368 loop upon receiving such errors. In future, qemu could be taught to be more
1369 resilient for selective requests.
1370
1371 For the message types that already solicit a reply from the client,
1372 the presence of ``VHOST_USER_PROTOCOL_F_REPLY_ACK`` or need_reply bit
1373 being set brings no behavioural change. (See the Communication_
1374 section for details.)
1375
1376 .. _backend_conventions:
1377
1378 Backend program conventions
1379 ===========================
1380
1381 vhost-user backends can provide various devices & services and may
1382 need to be configured manually depending on the use case. However, it
1383 is a good idea to follow the conventions listed here when
1384 possible. Users, QEMU or libvirt, can then rely on some common
1385 behaviour to avoid heterogenous configuration and management of the
1386 backend programs and facilitate interoperability.
1387
1388 Each backend installed on a host system should come with at least one
1389 JSON file that conforms to the vhost-user.json schema. Each file
1390 informs the management applications about the backend type, and binary
1391 location. In addition, it defines rules for management apps for
1392 picking the highest priority backend when multiple match the search
1393 criteria (see ``@VhostUserBackend`` documentation in the schema file).
1394
1395 If the backend is not capable of enabling a requested feature on the
1396 host (such as 3D acceleration with virgl), or the initialization
1397 failed, the backend should fail to start early and exit with a status
1398 != 0. It may also print a message to stderr for further details.
1399
1400 The backend program must not daemonize itself, but it may be
1401 daemonized by the management layer. It may also have a restricted
1402 access to the system.
1403
1404 File descriptors 0, 1 and 2 will exist, and have regular
1405 stdin/stdout/stderr usage (they may have been redirected to /dev/null
1406 by the management layer, or to a log handler).
1407
1408 The backend program must end (as quickly and cleanly as possible) when
1409 the SIGTERM signal is received. Eventually, it may receive SIGKILL by
1410 the management layer after a few seconds.
1411
1412 The following command line options have an expected behaviour. They
1413 are mandatory, unless explicitly said differently:
1414
1415 --socket-path=PATH
1416
1417   This option specify the location of the vhost-user Unix domain socket.
1418   It is incompatible with --fd.
1419
1420 --fd=FDNUM
1421
1422   When this argument is given, the backend program is started with the
1423   vhost-user socket as file descriptor FDNUM. It is incompatible with
1424   --socket-path.
1425
1426 --print-capabilities
1427
1428   Output to stdout the backend capabilities in JSON format, and then
1429   exit successfully. Other options and arguments should be ignored, and
1430   the backend program should not perform its normal function.  The
1431   capabilities can be reported dynamically depending on the host
1432   capabilities.
1433
1434 The JSON output is described in the ``vhost-user.json`` schema, by
1435 ```@VHostUserBackendCapabilities``.  Example:
1436
1437 .. code:: json
1438
1439   {
1440     "type": "foo",
1441     "features": [
1442       "feature-a",
1443       "feature-b"
1444     ]
1445   }
1446
1447 vhost-user-input
1448 ----------------
1449
1450 Command line options:
1451
1452 --evdev-path=PATH
1453
1454   Specify the linux input device.
1455
1456   (optional)
1457
1458 --no-grab
1459
1460   Do no request exclusive access to the input device.
1461
1462   (optional)
1463
1464 vhost-user-gpu
1465 --------------
1466
1467 Command line options:
1468
1469 --render-node=PATH
1470
1471   Specify the GPU DRM render node.
1472
1473   (optional)
1474
1475 --virgl
1476
1477   Enable virgl rendering support.
1478
1479   (optional)
1480
1481 vhost-user-blk
1482 --------------
1483
1484 Command line options:
1485
1486 --blk-file=PATH
1487
1488   Specify block device or file path.
1489
1490   (optional)
1491
1492 --read-only
1493
1494   Enable read-only.
1495
1496   (optional)