rte_vhost_async.h

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2020 Intel Corporation
 */

#ifndef _RTE_VHOST_ASYNC_H_
#define _RTE_VHOST_ASYNC_H_

#include "rte_vhost.h"

struct rte_vhost_iov_iter {
    size_t offset;
    size_t count;
    struct iovec *iov;
    unsigned long nr_segs;
};

struct rte_vhost_async_desc {
    struct rte_vhost_iov_iter *src;
    struct rte_vhost_iov_iter *dst;
};

struct rte_vhost_async_status {
    uintptr_t *src_opaque_data;
    uintptr_t *dst_opaque_data;
};

struct rte_vhost_async_channel_ops {
    int32_t (*transfer_data)(int vid, uint16_t queue_id,
        struct rte_vhost_async_desc *descs,
        struct rte_vhost_async_status *opaque_data,
        uint16_t count);
    int32_t (*check_completed_copies)(int vid, uint16_t queue_id,
        struct rte_vhost_async_status *opaque_data,
        uint16_t max_packets);
};

struct async_inflight_info {
    struct rte_mbuf *mbuf;
    uint16_t descs; /* num of descs inflight */
    uint16_t nr_buffers; /* num of buffers inflight for packed ring */
};

enum {
    RTE_VHOST_ASYNC_INORDER = 1U << 0,
};

struct rte_vhost_async_config {
    uint32_t async_threshold;
    uint32_t features;
    uint32_t rsvd[2];
};

__rte_experimental
int rte_vhost_async_channel_register(int vid, uint16_t queue_id,
    struct rte_vhost_async_config config,
    struct rte_vhost_async_channel_ops *ops);

__rte_experimental
int rte_vhost_async_channel_unregister(int vid, uint16_t queue_id);

__rte_experimental
int rte_vhost_async_channel_register_thread_unsafe(int vid, uint16_t queue_id,
    struct rte_vhost_async_config config,
    struct rte_vhost_async_channel_ops *ops);

__rte_experimental
int rte_vhost_async_channel_unregister_thread_unsafe(int vid,
        uint16_t queue_id);

__rte_experimental
uint16_t rte_vhost_submit_enqueue_burst(int vid, uint16_t queue_id,
        struct rte_mbuf **pkts, uint16_t count,
        struct rte_mbuf **comp_pkts, uint32_t *comp_count);

__rte_experimental
uint16_t rte_vhost_poll_enqueue_completed(int vid, uint16_t queue_id,
        struct rte_mbuf **pkts, uint16_t count);

__rte_experimental
int rte_vhost_async_get_inflight(int vid, uint16_t queue_id);

__rte_experimental
uint16_t rte_vhost_clear_queue_thread_unsafe(int vid, uint16_t queue_id,
        struct rte_mbuf **pkts, uint16_t count);

#endif /* _RTE_VHOST_ASYNC_H_ */