vhost: support virtio status message
[dpdk.git] / lib / librte_vhost / vhost_user.h
index 0b2aff1..16fe03f 100644 (file)
@@ -1,34 +1,5 @@
-/*-
- *   BSD LICENSE
- *
- *   Copyright(c) 2010-2014 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.
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2010-2018 Intel Corporation
  */
 
 #ifndef _VHOST_NET_USER_H
 
 #define VHOST_MEMORY_MAX_NREGIONS 8
 
-#define VHOST_USER_PROTOCOL_F_MQ       0
-#define VHOST_USER_PROTOCOL_F_LOG_SHMFD        1
-#define VHOST_USER_PROTOCOL_F_RARP     2
-#define VHOST_USER_PROTOCOL_F_REPLY_ACK        3
-#define VHOST_USER_PROTOCOL_F_NET_MTU 4
-#define VHOST_USER_PROTOCOL_F_SLAVE_REQ 5
-
 #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_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) | \
+                                        (1ULL << VHOST_USER_PROTOCOL_F_STATUS))
 
 typedef enum VhostUserRequest {
        VHOST_USER_NONE = 0,
@@ -80,12 +49,24 @@ typedef enum VhostUserRequest {
        VHOST_USER_SEND_RARP = 19,
        VHOST_USER_NET_SET_MTU = 20,
        VHOST_USER_SET_SLAVE_REQ_FD = 21,
-       VHOST_USER_MAX
+       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_GET_INFLIGHT_FD = 31,
+       VHOST_USER_SET_INFLIGHT_FD = 32,
+       VHOST_USER_SET_STATUS = 39,
+       VHOST_USER_GET_STATUS = 40,
+       VHOST_USER_MAX = 41
 } VhostUserRequest;
 
 typedef enum VhostUserSlaveRequest {
        VHOST_USER_SLAVE_NONE = 0,
        VHOST_USER_SLAVE_IOTLB_MSG = 1,
+       VHOST_USER_SLAVE_CONFIG_CHANGE_MSG = 2,
+       VHOST_USER_SLAVE_VRING_HOST_NOTIFIER_MSG = 3,
        VHOST_USER_SLAVE_MAX
 } VhostUserSlaveRequest;
 
@@ -107,8 +88,48 @@ typedef struct VhostUserLog {
        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 VhostUserInflight {
+       uint64_t mmap_size;
+       uint64_t mmap_offset;
+       uint16_t num_queues;
+       uint16_t queue_size;
+} VhostUserInflight;
+
 typedef struct VhostUserMsg {
-       VhostUserRequest request;
+       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)
@@ -124,9 +145,13 @@ typedef struct VhostUserMsg {
                VhostUserMemory memory;
                VhostUserLog    log;
                struct vhost_iotlb_msg iotlb;
+               VhostUserCryptoSessionParam crypto_session;
+               VhostUserVringArea area;
+               VhostUserInflight inflight;
        } payload;
        int fds[VHOST_MEMORY_MAX_NREGIONS];
-} __attribute((packed)) VhostUserMsg;
+       int fd_num;
+} __rte_packed VhostUserMsg;
 
 #define VHOST_USER_HDR_SIZE offsetof(VhostUserMsg, payload.u64)
 
@@ -139,7 +164,8 @@ 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 fd_num);
+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