src/plugins/vhost/virtio_std.h

   1 /*
   2  * Copyright (c) 2015 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 #ifndef __VIRTIO_STD_H__
  16 #define __VIRTIO_STD_H__
  17
  18 #define foreach_virtio_net_features                                           \
  19   _ (VIRTIO_NET_F_CSUM, 0)       /* Host handles pkts w/ partial csum */      \
  20   _ (VIRTIO_NET_F_GUEST_CSUM, 1) /* Guest handles pkts w/ partial csum */     \
  21   _ (VIRTIO_NET_F_CTRL_GUEST_OFFLOADS,                                        \
  22      2)                              /* Dynamic offload configuration. */     \
  23   _ (VIRTIO_NET_F_MTU, 3)            /* Initial MTU advice. */                \
  24   _ (VIRTIO_NET_F_MAC, 5)            /* Host has given MAC address. */        \
  25   _ (VIRTIO_NET_F_GSO, 6)            /* Host handles pkts w/ any GSO. */      \
  26   _ (VIRTIO_NET_F_GUEST_TSO4, 7)     /* Guest can handle TSOv4 in. */         \
  27   _ (VIRTIO_NET_F_GUEST_TSO6, 8)     /* Guest can handle TSOv6 in. */         \
  28   _ (VIRTIO_NET_F_GUEST_ECN, 9)      /* Guest can handle TSO[6] w/ ECN in. */ \
  29   _ (VIRTIO_NET_F_GUEST_UFO, 10)     /* Guest can handle UFO in. */           \
  30   _ (VIRTIO_NET_F_HOST_TSO4, 11)     /* Host can handle TSOv4 in. */          \
  31   _ (VIRTIO_NET_F_HOST_TSO6, 12)     /* Host can handle TSOv6 in. */          \
  32   _ (VIRTIO_NET_F_HOST_ECN, 13)      /* Host can handle TSO[6] w/ ECN in. */  \
  33   _ (VIRTIO_NET_F_HOST_UFO, 14)      /* Host can handle UFO in. */            \
  34   _ (VIRTIO_NET_F_MRG_RXBUF, 15)     /* Host can merge receive buffers. */    \
  35   _ (VIRTIO_NET_F_STATUS, 16)        /* virtio_net_config.status available */ \
  36   _ (VIRTIO_NET_F_CTRL_VQ, 17)       /* Control channel available */          \
  37   _ (VIRTIO_NET_F_CTRL_RX, 18)       /* Control channel RX mode support */    \
  38   _ (VIRTIO_NET_F_CTRL_VLAN, 19)     /* Control channel VLAN filtering */     \
  39   _ (VIRTIO_NET_F_CTRL_RX_EXTRA, 20) /* Extra RX mode control support */      \
  40   _ (VIRTIO_NET_F_GUEST_ANNOUNCE,                                             \
  41      21)                  /* Guest can announce device on the network */      \
  42   _ (VIRTIO_NET_F_MQ, 22) /* Device supports Receive Flow Steering */         \
  43   _ (VIRTIO_NET_F_CTRL_MAC_ADDR, 23) /* Set MAC address */                    \
  44   _ (VIRTIO_F_NOTIFY_ON_EMPTY, 24)                                            \
  45   _ (VHOST_F_LOG_ALL, 26) /* Log all write descriptors */                     \
  46   _ (VIRTIO_F_ANY_LAYOUT,                                                     \
  47      27) /* Can the device handle any descriptor layout */                    \
  48   _ (VIRTIO_RING_F_INDIRECT_DESC,                                             \
  49      28) /* Support indirect buffer descriptors */                            \
  50   _ (VIRTIO_RING_F_EVENT_IDX,                                                 \
  51      29) /* The Guest publishes the used index for which it expects an        \
  52           * interrupt at the end of the avail ring. Host should ignore the    \
  53           * avail->flags field. */                                            \
  54   /* The Host publishes the avail index for which it expects a kick           \
  55    * at the end of the used ring. Guest should ignore the used->flags field.  \
  56    */                                                                         \
  57   _ (VHOST_USER_F_PROTOCOL_FEATURES, 30)                                      \
  58   _ (VIRTIO_F_VERSION_1, 32) /* v1.0 compliant. */                            \
  59   _ (VIRTIO_F_IOMMU_PLATFORM, 33)                                             \
  60   _ (VIRTIO_F_RING_PACKED, 34)                                                \
  61   _ (VIRTIO_F_IN_ORDER, 35) /* all buffers are used by the device in the */   \
  62   /* same order in which they have been made available */                     \
  63   _ (VIRTIO_F_ORDER_PLATFORM, 36) /* memory accesses by the driver and the */ \
  64   /* device are ordered in a way described by the platfor */                  \
  65   _ (VIRTIO_F_NOTIFICATION_DATA,                                              \
  66      38) /* the driver passes extra data (besides */                          \
  67   /* identifying the virtqueue) in its device notifications. */               \
  68   _ (VIRTIO_NET_F_SPEED_DUPLEX, 63) /* Device set linkspeed and duplex */
  69
  70 typedef enum
  71 {
  72 #define _(f, n) f = n,
  73   foreach_virtio_net_features
  74 #undef _
  75 } vnet_virtio_net_feature_t;
  76
  77 #define VIRTIO_FEATURE(X) (1ULL << X)
  78
  79 #define VRING_MAX_SIZE 32768
  80
  81 #define VRING_DESC_F_NEXT     1
  82 #define VRING_DESC_F_WRITE    2
  83 #define VRING_DESC_F_INDIRECT 4
  84
  85 #define VRING_DESC_F_AVAIL (1 << 7)
  86 #define VRING_DESC_F_USED  (1 << 15)
  87
  88 #define foreach_virtio_event_idx_flags                                        \
  89   _ (VRING_EVENT_F_ENABLE, 0)                                                 \
  90   _ (VRING_EVENT_F_DISABLE, 1)                                                \
  91   _ (VRING_EVENT_F_DESC, 2)
  92
  93 typedef enum
  94 {
  95 #define _(f, n) f = n,
  96   foreach_virtio_event_idx_flags
  97 #undef _
  98 } vnet_virtio_event_idx_flags_t;
  99
 100 #define VRING_USED_F_NO_NOTIFY     1
 101 #define VRING_AVAIL_F_NO_INTERRUPT 1
 102
 103 typedef struct
 104 {
 105   u64 addr;
 106   u32 len;
 107   u16 flags;
 108   u16 next;
 109 } vnet_virtio_vring_desc_t;
 110
 111 typedef struct
 112 {
 113   u16 flags;
 114   u16 idx;
 115   u16 ring[0];
 116   /*  u16 used_event; */
 117 } vnet_virtio_vring_avail_t;
 118
 119 typedef struct
 120 {
 121   u32 id;
 122   u32 len;
 123 } vnet_virtio_vring_used_elem_t;
 124
 125 typedef struct
 126 {
 127   u16 flags;
 128   u16 idx;
 129   vnet_virtio_vring_used_elem_t ring[0];
 130   /* u16 avail_event; */
 131 } vnet_virtio_vring_used_t;
 132
 133 typedef CLIB_PACKED (struct {
 134   u64 addr;  // packet data buffer address
 135   u32 len;   // packet data buffer size
 136   u16 id;    // buffer id
 137   u16 flags; // flags
 138 }) vnet_virtio_vring_packed_desc_t;
 139
 140 STATIC_ASSERT_SIZEOF (vnet_virtio_vring_packed_desc_t, 16);
 141
 142 typedef CLIB_PACKED (struct {
 143   u16 off_wrap;
 144   u16 flags;
 145 }) vnet_virtio_vring_desc_event_t;
 146
 147 #define VIRTIO_NET_HDR_F_NEEDS_CSUM 1 /* Use csum_start, csum_offset */
 148 #define VIRTIO_NET_HDR_F_DATA_VALID 2 /* Csum is valid */
 149
 150 #define VIRTIO_NET_HDR_GSO_NONE  0    /* Not a GSO frame */
 151 #define VIRTIO_NET_HDR_GSO_TCPV4 1    /* GSO frame, IPv4 TCP (TSO) */
 152 #define VIRTIO_NET_HDR_GSO_UDP   3    /* GSO frame, IPv4 UDP (UFO) */
 153 #define VIRTIO_NET_HDR_GSO_TCPV6 4    /* GSO frame, IPv6 TCP */
 154 #define VIRTIO_NET_HDR_GSO_ECN   0x80 /* TCP has ECN set */
 155
 156 typedef CLIB_PACKED (struct {
 157   u8 flags;
 158   u8 gso_type;
 159   u16 hdr_len;     /* Ethernet + IP + tcp/udp hdrs */
 160   u16 gso_size;    /* Bytes to append to hdr_len per frame */
 161   u16 csum_start;  /* Position to start checksumming from */
 162   u16 csum_offset; /* Offset after that to place checksum */
 163   u16 num_buffers; /* Number of merged rx buffers */
 164 }) vnet_virtio_net_hdr_v1_t;
 165
 166 typedef CLIB_PACKED (struct {
 167   u8 flags;
 168   u8 gso_type;
 169   u16 hdr_len;
 170   u16 gso_size;
 171   u16 csum_start;
 172   u16 csum_offset;
 173 }) vnet_virtio_net_hdr_t;
 174
 175 typedef CLIB_PACKED (struct {
 176   vnet_virtio_net_hdr_t hdr;
 177   u16 num_buffers;
 178 }) vnet_virtio_net_hdr_mrg_rxbuf_t;
 179
 180 #endif
 181
 182 /*
 183  * fd.io coding-style-patch-verification: ON
 184  *
 185  * Local Variables:
 186  * eval: (c-set-style "gnu")
 187  * End:
 188  */