lib/librte_vhost/vhost-net-cdev.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _VHOST_NET_CDEV_H_
  35 #define _VHOST_NET_CDEV_H_
  36
  37 #include <linux/vhost.h>
  38
  39 struct vhost_memory;
  40 struct vhost_vring_state;
  41 struct vhost_vring_addr;
  42 struct vhost_vring_file;
  43 /* Macros for printing using RTE_LOG */
  44 #define RTE_LOGTYPE_VHOST_CONFIG RTE_LOGTYPE_USER1
  45 #define RTE_LOGTYPE_VHOST_DATA   RTE_LOGTYPE_USER1
  46
  47 #ifdef RTE_LIBRTE_VHOST_DEBUG
  48 #define VHOST_MAX_PRINT_BUFF 6072
  49 #define LOG_LEVEL RTE_LOG_DEBUG
  50 #define LOG_DEBUG(log_type, fmt, args...) RTE_LOG(DEBUG, log_type, fmt, ##args)
  51 #define PRINT_PACKET(device, addr, size, header) do { \
  52         char *pkt_addr = (char *)(addr); \
  53         unsigned int index; \
  54         char packet[VHOST_MAX_PRINT_BUFF]; \
  55         \
  56         if ((header)) \
  57                 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%"PRIu64") Header size %d: ", (device->device_fh), (size)); \
  58         else \
  59                 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%"PRIu64") Packet size %d: ", (device->device_fh), (size)); \
  60         for (index = 0; index < (size); index++) { \
  61                 snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), \
  62                         "%02hhx ", pkt_addr[index]); \
  63         } \
  64         snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), "\n"); \
  65         \
  66         LOG_DEBUG(VHOST_DATA, "%s", packet); \
  67 } while (0)
  68 #else
  69 #define LOG_LEVEL RTE_LOG_INFO
  70 #define LOG_DEBUG(log_type, fmt, args...) do {} while (0)
  71 #define PRINT_PACKET(device, addr, size, header) do {} while (0)
  72 #endif
  73
  74
  75 /*
  76  * Structure used to identify device context.
  77  */
  78 struct vhost_device_ctx
  79 {
  80         pid_t           pid;    /* PID of process calling the IOCTL. */
  81         uint64_t        fh;             /* Populated with fi->fh to track the device index. */
  82 };
  83
  84 /*
  85  * Structure contains function pointers to be defined in virtio-net.c. These
  86  * functions are called in CUSE context and are used to configure devices.
  87  */
  88 struct vhost_net_device_ops {
  89         int (* new_device)              (struct vhost_device_ctx);
  90         void (* destroy_device) (struct vhost_device_ctx);
  91
  92         int (* get_features)    (struct vhost_device_ctx, uint64_t *);
  93         int (* set_features)    (struct vhost_device_ctx, uint64_t *);
  94
  95         int (* set_mem_table)   (struct vhost_device_ctx, const void *, uint32_t);
  96
  97         int (* set_vring_num)   (struct vhost_device_ctx, struct vhost_vring_state *);
  98         int (* set_vring_addr)  (struct vhost_device_ctx, struct vhost_vring_addr *);
  99         int (* set_vring_base)  (struct vhost_device_ctx, struct vhost_vring_state *);
 100         int (* get_vring_base)  (struct vhost_device_ctx, uint32_t, struct vhost_vring_state *);
 101
 102         int (* set_vring_kick)  (struct vhost_device_ctx, struct vhost_vring_file *);
 103         int (* set_vring_call)  (struct vhost_device_ctx, struct vhost_vring_file *);
 104
 105         int (* set_backend)     (struct vhost_device_ctx, struct vhost_vring_file *);
 106
 107         int (* set_owner)               (struct vhost_device_ctx);
 108         int (* reset_owner)     (struct vhost_device_ctx);
 109 };
 110
 111
 112 struct vhost_net_device_ops const *get_virtio_net_callbacks(void);
 113 #endif /* _VHOST_NET_CDEV_H_ */