subprojects/libvhost-user/libvhost-user.h

10  * This work is licensed under the terms of the GNU GPL, version 2 or
11  * later.  See the COPYING file in the top-level directory.
34  * vhost in the kernel usually supports 509 mem slots. 509 used to be the
198     uint32_t size; /* the following payload size */
249     /* called by VHOST_USER_GET_FEATURES to get the features bitmask */
253     /* get the protocol feature bitmask from the underlying vhost
256     /* enable protocol features in the underlying vhost implementation. */
264      * If the queue is processed in order, in which case it will be
269     /* get the config space of the device */
271     /* set the config space of the device */
273     /* get virtio shared object from the underlying vhost implementation. */
296     /* Maintain a list for the last batch of used descriptors.
300     /* Used to preserve the order of fetching available descriptors.
306     /* The feature flags of this region. Now it's initialized to 0. */
309     /* The version of this region. It's 1 currently.
314      * The size of VuDescStateSplit array. It's equal to the virtqueue size.
319     /* The head of list that track the last batch of used descriptors. */
322     /* Storing the idx value of used ring */
325     /* Used to track the state of each descriptor in descriptor table */
417      * the passed VhostUserMsg *vmsg struct.
419      * If reading fails, it should close the received set of file
422      * For the details, please refer to vu_message_read in libvhost-user.c
433      * @set_watch: add or update the given fd to the watch set,
438     /* @remove_watch: remove the given fd from the watch set */
464  * @socket: the socket connected to vhost-user frontend
488  * Cleans up the VuDev context
526  * Returns the queue number @qidx.
534  * @handler: the queue handler callback
536  * Set the queue handler. This function may be called several times
537  * for the same queue. If called with NULL @handler, the handler is
552  * times for the same queue. If called with -1 @fd, the notifier
561  * @uuid: UUID of the shared object
564  * Lookup for a virtio shared object (i.e., dma-buf fd) associated with the
565  * received UUID. Result, if found, is stored in the dmabuf_fd argument.
567  * Returns: whether the virtio object was found.
575  * @uuid: UUID of the shared object
577  * Registers this back-end as the exporter for the object associated with
578  * the received UUID.
587  * @uuid: UUID of the shared object
589  * Removes a shared object entry (i.e., back-end entry) associated with the
590  * received UUID key from the hash table.
602  * Set whether the queue notifies (via event index or interrupt)
611  * Returns: whether the queue is enabled.
620  * Returns: whether the queue is started.
629  * Returns: true if the queue is empty or not ready.
638  * Request to notify the queue via callfd (skipped if unnecessary)
649  * Request to notify the queue via callfd (skipped if unnecessary)
658  * @sz: the size of struct to return (must be >= VuVirtqElement)
660  * Returns: a VuVirtqElement filled from the queue or NULL. The
661  * returned element must be free()-d by the caller.
670  * @elem: The #VuVirtqElement
673  * Pretend the most recent element wasn't popped from the virtqueue.  The next
674  * call to vu_queue_pop() will refetch the element.
685  * Pretend that elements weren't popped from the virtqueue.  The next
686  * virtqueue_pop() will refetch the oldest element.
688  * Returns: true on success, false if @num is greater than the number of in use
699  * @idx: optional offset for the used ring index (0 in general)
701  * Fill the used ring with @elem element.
725  * Mark the last number of elements as done (used.idx is updated by
739  * Count the number of available bytes, up to max_in_bytes/max_out_bytes.