[ceph.git] / ceph / src / seastar / dpdk / lib / librte_vhost / vhost_user.h

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

#ifndef _VHOST_NET_USER_H
#define _VHOST_NET_USER_H

#include <stdint.h>
#include <linux/vhost.h>

#include "rte_vhost.h"

/* refer to hw/virtio/vhost-user.c */

#define VHOST_MEMORY_MAX_NREGIONS 8

#define VHOST_USER_PROTOCOL_FEATURES	((1ULL << VHOST_USER_PROTOCOL_F_MQ) | \
					 (1ULL << VHOST_USER_PROTOCOL_F_LOG_SHMFD) |\
					 (1ULL << VHOST_USER_PROTOCOL_F_RARP) | \
					 (1ULL << VHOST_USER_PROTOCOL_F_REPLY_ACK) | \
					 (1ULL << VHOST_USER_PROTOCOL_F_NET_MTU) | \
					 (1ULL << VHOST_USER_PROTOCOL_F_SLAVE_REQ) | \
					 (1ULL << VHOST_USER_PROTOCOL_F_CRYPTO_SESSION) | \
					 (1ULL << VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD) | \
					 (1ULL << VHOST_USER_PROTOCOL_F_HOST_NOTIFIER) | \
					 (1ULL << VHOST_USER_PROTOCOL_F_PAGEFAULT))

typedef enum VhostUserRequest {
	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_SEND_RARP = 19,
	VHOST_USER_NET_SET_MTU = 20,
	VHOST_USER_SET_SLAVE_REQ_FD = 21,
	VHOST_USER_IOTLB_MSG = 22,
	VHOST_USER_CRYPTO_CREATE_SESS = 26,
	VHOST_USER_CRYPTO_CLOSE_SESS = 27,
	VHOST_USER_POSTCOPY_ADVISE = 28,
	VHOST_USER_POSTCOPY_LISTEN = 29,
	VHOST_USER_POSTCOPY_END = 30,
	VHOST_USER_MAX = 31
} VhostUserRequest;

typedef enum VhostUserSlaveRequest {
	VHOST_USER_SLAVE_NONE = 0,
	VHOST_USER_SLAVE_IOTLB_MSG = 1,
	VHOST_USER_SLAVE_VRING_HOST_NOTIFIER_MSG = 3,
	VHOST_USER_SLAVE_MAX
} VhostUserSlaveRequest;

typedef struct VhostUserMemoryRegion {
	uint64_t guest_phys_addr;
	uint64_t memory_size;
	uint64_t userspace_addr;
	uint64_t mmap_offset;
} VhostUserMemoryRegion;

typedef struct VhostUserMemory {
	uint32_t nregions;
	uint32_t padding;
	VhostUserMemoryRegion regions[VHOST_MEMORY_MAX_NREGIONS];
} VhostUserMemory;

typedef struct VhostUserLog {
	uint64_t mmap_size;
	uint64_t mmap_offset;
} VhostUserLog;

/* Comply with Cryptodev-Linux */
#define VHOST_USER_CRYPTO_MAX_HMAC_KEY_LENGTH	512
#define VHOST_USER_CRYPTO_MAX_CIPHER_KEY_LENGTH	64

/* Same structure as vhost-user backend session info */
typedef struct VhostUserCryptoSessionParam {
	int64_t session_id;
	uint32_t op_code;
	uint32_t cipher_algo;
	uint32_t cipher_key_len;
	uint32_t hash_algo;
	uint32_t digest_len;
	uint32_t auth_key_len;
	uint32_t aad_len;
	uint8_t op_type;
	uint8_t dir;
	uint8_t hash_mode;
	uint8_t chaining_dir;
	uint8_t *ciphe_key;
	uint8_t *auth_key;
	uint8_t cipher_key_buf[VHOST_USER_CRYPTO_MAX_CIPHER_KEY_LENGTH];
	uint8_t auth_key_buf[VHOST_USER_CRYPTO_MAX_HMAC_KEY_LENGTH];
} VhostUserCryptoSessionParam;

typedef struct VhostUserVringArea {
	uint64_t u64;
	uint64_t size;
	uint64_t offset;
} VhostUserVringArea;

typedef struct VhostUserMsg {
	union {
		uint32_t master; /* a VhostUserRequest value */
		uint32_t slave;  /* a VhostUserSlaveRequest value*/
	} request;

#define VHOST_USER_VERSION_MASK     0x3
#define VHOST_USER_REPLY_MASK       (0x1 << 2)
#define VHOST_USER_NEED_REPLY		(0x1 << 3)
	uint32_t flags;
	uint32_t size; /* the following payload size */
	union {
#define VHOST_USER_VRING_IDX_MASK   0xff
#define VHOST_USER_VRING_NOFD_MASK  (0x1<<8)
		uint64_t u64;
		struct vhost_vring_state state;
		struct vhost_vring_addr addr;
		VhostUserMemory memory;
		VhostUserLog    log;
		struct vhost_iotlb_msg iotlb;
		VhostUserCryptoSessionParam crypto_session;
		VhostUserVringArea area;
	} payload;
	int fds[VHOST_MEMORY_MAX_NREGIONS];
	int fd_num;
} __attribute((packed)) VhostUserMsg;

#define VHOST_USER_HDR_SIZE offsetof(VhostUserMsg, payload.u64)

/* The version of the protocol we support */
#define VHOST_USER_VERSION    0x1


/* vhost_user.c */
int vhost_user_msg_handler(int vid, int fd);
int vhost_user_iotlb_miss(struct virtio_net *dev, uint64_t iova, uint8_t perm);

/* socket.c */
int read_fd_message(int sockfd, char *buf, int buflen, int *fds, int max_fds,
		int *fd_num);
int send_fd_message(int sockfd, char *buf, int buflen, int *fds, int fd_num);

#endif
Commit	Line	Data
9f95a23c TL	1	/* SPDX-License-Identifier: BSD-3-Clause
9f95a23c TL	2	* Copyright(c) 2010-2018 Intel Corporation
7c673cae FG	3	*/
	4
	5	#ifndef _VHOST_NET_USER_H
	6	#define _VHOST_NET_USER_H
	7
	8	#include <stdint.h>
	9	#include <linux/vhost.h>
	10
11fdf7f2	11	#include "rte_vhost.h"
7c673cae FG	12
	13	/* refer to hw/virtio/vhost-user.c */
	14
	15	#define VHOST_MEMORY_MAX_NREGIONS 8
	16
7c673cae FG	17	#define VHOST_USER_PROTOCOL_FEATURES ((1ULL << VHOST_USER_PROTOCOL_F_MQ) \| \
7c673cae FG	18	(1ULL << VHOST_USER_PROTOCOL_F_LOG_SHMFD) \|\
11fdf7f2	19	(1ULL << VHOST_USER_PROTOCOL_F_RARP) \| \
9f95a23c TL	20	(1ULL << VHOST_USER_PROTOCOL_F_REPLY_ACK) \| \
	21	(1ULL << VHOST_USER_PROTOCOL_F_NET_MTU) \| \
	22	(1ULL << VHOST_USER_PROTOCOL_F_SLAVE_REQ) \| \
	23	(1ULL << VHOST_USER_PROTOCOL_F_CRYPTO_SESSION) \| \
	24	(1ULL << VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD) \| \
	25	(1ULL << VHOST_USER_PROTOCOL_F_HOST_NOTIFIER) \| \
	26	(1ULL << VHOST_USER_PROTOCOL_F_PAGEFAULT))
7c673cae FG	27
	28	typedef enum VhostUserRequest {
	29	VHOST_USER_NONE = 0,
	30	VHOST_USER_GET_FEATURES = 1,
	31	VHOST_USER_SET_FEATURES = 2,
	32	VHOST_USER_SET_OWNER = 3,
	33	VHOST_USER_RESET_OWNER = 4,
	34	VHOST_USER_SET_MEM_TABLE = 5,
	35	VHOST_USER_SET_LOG_BASE = 6,
	36	VHOST_USER_SET_LOG_FD = 7,
	37	VHOST_USER_SET_VRING_NUM = 8,
	38	VHOST_USER_SET_VRING_ADDR = 9,
	39	VHOST_USER_SET_VRING_BASE = 10,
	40	VHOST_USER_GET_VRING_BASE = 11,
	41	VHOST_USER_SET_VRING_KICK = 12,
	42	VHOST_USER_SET_VRING_CALL = 13,
	43	VHOST_USER_SET_VRING_ERR = 14,
	44	VHOST_USER_GET_PROTOCOL_FEATURES = 15,
	45	VHOST_USER_SET_PROTOCOL_FEATURES = 16,
	46	VHOST_USER_GET_QUEUE_NUM = 17,
	47	VHOST_USER_SET_VRING_ENABLE = 18,
	48	VHOST_USER_SEND_RARP = 19,
11fdf7f2	49	VHOST_USER_NET_SET_MTU = 20,
9f95a23c TL	50	VHOST_USER_SET_SLAVE_REQ_FD = 21,
	51	VHOST_USER_IOTLB_MSG = 22,
	52	VHOST_USER_CRYPTO_CREATE_SESS = 26,
	53	VHOST_USER_CRYPTO_CLOSE_SESS = 27,
	54	VHOST_USER_POSTCOPY_ADVISE = 28,
	55	VHOST_USER_POSTCOPY_LISTEN = 29,
	56	VHOST_USER_POSTCOPY_END = 30,
	57	VHOST_USER_MAX = 31
7c673cae FG	58	} VhostUserRequest;
7c673cae FG	59
9f95a23c TL	60	typedef enum VhostUserSlaveRequest {
	61	VHOST_USER_SLAVE_NONE = 0,
	62	VHOST_USER_SLAVE_IOTLB_MSG = 1,
	63	VHOST_USER_SLAVE_VRING_HOST_NOTIFIER_MSG = 3,
	64	VHOST_USER_SLAVE_MAX
	65	} VhostUserSlaveRequest;
	66
7c673cae FG	67	typedef struct VhostUserMemoryRegion {
	68	uint64_t guest_phys_addr;
	69	uint64_t memory_size;
	70	uint64_t userspace_addr;
	71	uint64_t mmap_offset;
	72	} VhostUserMemoryRegion;
	73
	74	typedef struct VhostUserMemory {
	75	uint32_t nregions;
	76	uint32_t padding;
	77	VhostUserMemoryRegion regions[VHOST_MEMORY_MAX_NREGIONS];
	78	} VhostUserMemory;
	79
	80	typedef struct VhostUserLog {
	81	uint64_t mmap_size;
	82	uint64_t mmap_offset;
	83	} VhostUserLog;
	84
9f95a23c TL	85	/* Comply with Cryptodev-Linux */
	86	#define VHOST_USER_CRYPTO_MAX_HMAC_KEY_LENGTH 512
	87	#define VHOST_USER_CRYPTO_MAX_CIPHER_KEY_LENGTH 64
	88
	89	/* Same structure as vhost-user backend session info */
	90	typedef struct VhostUserCryptoSessionParam {
	91	int64_t session_id;
	92	uint32_t op_code;
	93	uint32_t cipher_algo;
	94	uint32_t cipher_key_len;
	95	uint32_t hash_algo;
	96	uint32_t digest_len;
	97	uint32_t auth_key_len;
	98	uint32_t aad_len;
	99	uint8_t op_type;
	100	uint8_t dir;
	101	uint8_t hash_mode;
	102	uint8_t chaining_dir;
	103	uint8_t *ciphe_key;
	104	uint8_t *auth_key;
	105	uint8_t cipher_key_buf[VHOST_USER_CRYPTO_MAX_CIPHER_KEY_LENGTH];
	106	uint8_t auth_key_buf[VHOST_USER_CRYPTO_MAX_HMAC_KEY_LENGTH];
	107	} VhostUserCryptoSessionParam;
	108
	109	typedef struct VhostUserVringArea {
	110	uint64_t u64;
	111	uint64_t size;
	112	uint64_t offset;
	113	} VhostUserVringArea;
	114
7c673cae	115	typedef struct VhostUserMsg {
9f95a23c TL	116	union {
	117	uint32_t master; /* a VhostUserRequest value */
	118	uint32_t slave; /* a VhostUserSlaveRequest value*/
	119	} request;
7c673cae FG	120
	121	#define VHOST_USER_VERSION_MASK 0x3
	122	#define VHOST_USER_REPLY_MASK (0x1 << 2)
11fdf7f2	123	#define VHOST_USER_NEED_REPLY (0x1 << 3)
7c673cae FG	124	uint32_t flags;
	125	uint32_t size; /* the following payload size */
	126	union {
	127	#define VHOST_USER_VRING_IDX_MASK 0xff
	128	#define VHOST_USER_VRING_NOFD_MASK (0x1<<8)
	129	uint64_t u64;
	130	struct vhost_vring_state state;
	131	struct vhost_vring_addr addr;
	132	VhostUserMemory memory;
	133	VhostUserLog log;
9f95a23c TL	134	struct vhost_iotlb_msg iotlb;
	135	VhostUserCryptoSessionParam crypto_session;
	136	VhostUserVringArea area;
7c673cae FG	137	} payload;
7c673cae FG	138	int fds[VHOST_MEMORY_MAX_NREGIONS];
9f95a23c	139	int fd_num;
7c673cae FG	140	} __attribute((packed)) VhostUserMsg;
	141
	142	#define VHOST_USER_HDR_SIZE offsetof(VhostUserMsg, payload.u64)
	143
	144	/* The version of the protocol we support */
	145	#define VHOST_USER_VERSION 0x1
	146
	147
	148	/* vhost_user.c */
	149	int vhost_user_msg_handler(int vid, int fd);
9f95a23c	150	int vhost_user_iotlb_miss(struct virtio_net *dev, uint64_t iova, uint8_t perm);
7c673cae FG	151
7c673cae FG	152	/* socket.c */
9f95a23c TL	153	int read_fd_message(int sockfd, char buf, int buflen, int fds, int max_fds,
9f95a23c TL	154	int *fd_num);
7c673cae FG	155	int send_fd_message(int sockfd, char buf, int buflen, int fds, int fd_num);
	156
	157	#endif