text: /*-
   *   BSD LICENSE
   *
   *   Copyright(c) 2010-2016 Intel Corporation. All rights reserved.
   *   All rights reserved.
   *
   *   Redistribution and use in source and binary forms, with or without
   *   modification, are permitted provided that the following conditions
   *   are met:
   *
   *     * Redistributions of source code must retain the above copyright
   *       notice, this list of conditions and the following disclaimer.
   *     * Redistributions in binary form must reproduce the above copyright
   *       notice, this list of conditions and the following disclaimer in
   *       the documentation and/or other materials provided with the
   *       distribution.
   *     * Neither the name of Intel Corporation nor the names of its
   *       contributors may be used to endorse or promote products derived
   *       from this software without specific prior written permission.
   *
   *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
   *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
   *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
   *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   */
  
  #ifndef _VHOST_NET_USER_H
  #define _VHOST_NET_USER_H
  
  #include "spdk/stdinc.h"
  
  #include <linux/vhost.h>
  
  #include "spdk_internal/log.h"
  #include "spdk_internal/virtio.h"
  
  #define VHOST_USER_MAX_CONFIG_SIZE 256
  
  enum vhost_user_request {
  	VHOST_USER_NONE = 0,
  	VHOST_USER_GET_FEATURES = 1,
  	VHOST_USER_SET_FEATURES = 2,
  	VHOST_USER_SET_OWNER = 3,
  	VHOST_USER_RESET_OWNER = 4,
  	VHOST_USER_SET_MEM_TABLE = 5,
  	VHOST_USER_SET_LOG_BASE = 6,
  	VHOST_USER_SET_LOG_FD = 7,
  	VHOST_USER_SET_VRING_NUM = 8,
  	VHOST_USER_SET_VRING_ADDR = 9,
  	VHOST_USER_SET_VRING_BASE = 10,
  	VHOST_USER_GET_VRING_BASE = 11,
  	VHOST_USER_SET_VRING_KICK = 12,
  	VHOST_USER_SET_VRING_CALL = 13,
  	VHOST_USER_SET_VRING_ERR = 14,
  	VHOST_USER_GET_PROTOCOL_FEATURES = 15,
  	VHOST_USER_SET_PROTOCOL_FEATURES = 16,
  	VHOST_USER_GET_QUEUE_NUM = 17,
  	VHOST_USER_SET_VRING_ENABLE = 18,
  	VHOST_USER_GET_CONFIG = 24,
  	VHOST_USER_SET_CONFIG = 25,
  	VHOST_USER_MAX
  };
  
  struct virtio_user_backend_ops;
  
  struct virtio_user_dev {
  	/* for vhost_user backend */
  	int		vhostfd;
  
  	/* for both vhost_user and vhost_kernel */
  	int		callfds[SPDK_VIRTIO_MAX_VIRTQUEUES];
  	int		kickfds[SPDK_VIRTIO_MAX_VIRTQUEUES];
  	uint32_t	queue_size;
  
  	uint8_t		status;
  	char		path[PATH_MAX];
  	struct vring	vrings[SPDK_VIRTIO_MAX_VIRTQUEUES];
  	struct virtio_user_backend_ops *ops;
  };
  
  struct virtio_user_backend_ops {
  	int (*setup)(struct virtio_user_dev *dev);
  	int (*send_request)(struct virtio_user_dev *dev,
  			    enum vhost_user_request req,
  			    void *arg);
  };
  
  /* get/set config msg */
  struct vhost_user_config {
  	uint32_t offset;
  	uint32_t size;
  	uint32_t flags;
  	uint8_t region[VHOST_USER_MAX_CONFIG_SIZE];
  };
  
  extern struct virtio_user_backend_ops ops_user;
  extern struct virtio_user_backend_ops ops_kernel;
  
  #endif
  