src/vnet/devices/virtio/node.c

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2016 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *------------------------------------------------------------------
  16  */
  17
  18 #include <sys/types.h>
  19 #include <sys/stat.h>
  20 #include <fcntl.h>
  21 #include <net/if.h>
  22 #include <linux/if_tun.h>
  23 #include <sys/ioctl.h>
  24 #include <sys/eventfd.h>
  25
  26 #include <vlib/vlib.h>
  27 #include <vlib/unix/unix.h>
  28 #include <vnet/ethernet/ethernet.h>
  29 #include <vnet/devices/devices.h>
  30 #include <vnet/feature/feature.h>
  31 #include <vnet/ip/ip4_packet.h>
  32 #include <vnet/ip/ip6_packet.h>
  33 #include <vnet/udp/udp_packet.h>
  34 #include <vnet/devices/virtio/virtio.h>
  35
  36
  37 #define foreach_virtio_input_error \
  38   _(UNKNOWN, "unknown")
  39
  40 typedef enum
  41 {
  42 #define _(f,s) VIRTIO_INPUT_ERROR_##f,
  43   foreach_virtio_input_error
  44 #undef _
  45     VIRTIO_INPUT_N_ERROR,
  46 } virtio_input_error_t;
  47
  48 static char *virtio_input_error_strings[] = {
  49 #define _(n,s) s,
  50   foreach_virtio_input_error
  51 #undef _
  52 };
  53
  54 typedef struct
  55 {
  56   u32 next_index;
  57   u32 hw_if_index;
  58   u16 ring;
  59   u16 len;
  60   struct virtio_net_hdr_v1 hdr;
  61 } virtio_input_trace_t;
  62
  63 static u8 *
  64 format_virtio_input_trace (u8 * s, va_list * args)
  65 {
  66   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
  67   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
  68   virtio_input_trace_t *t = va_arg (*args, virtio_input_trace_t *);
  69   u32 indent = format_get_indent (s);
  70
  71   s = format (s, "virtio: hw_if_index %d next-index %d vring %u len %u",
  72               t->hw_if_index, t->next_index, t->ring, t->len);
  73   s = format (s, "\n%Uhdr: flags 0x%02x gso_type 0x%02x hdr_len %u "
  74               "gso_size %u csum_start %u csum_offset %u num_buffers %u",
  75               format_white_space, indent + 2,
  76               t->hdr.flags, t->hdr.gso_type, t->hdr.hdr_len, t->hdr.gso_size,
  77               t->hdr.csum_start, t->hdr.csum_offset, t->hdr.num_buffers);
  78   return s;
  79 }
  80
  81 static_always_inline void
  82 virtio_refill_vring (vlib_main_t * vm, virtio_if_t * vif,
  83                      virtio_vring_t * vring, const int hdr_sz)
  84 {
  85   u16 used, next, avail, n_slots;
  86   u16 sz = vring->size;
  87   u16 mask = sz - 1;
  88
  89 more:
  90   used = vring->desc_in_use;
  91
  92   if (sz - used < sz / 8)
  93     return;
  94
  95   /* deliver free buffers in chunks of 64 */
  96   n_slots = clib_min (sz - used, 64);
  97
  98   next = vring->desc_next;
  99   avail = vring->avail->idx;
 100   n_slots =
 101     vlib_buffer_alloc_to_ring_from_pool (vm, vring->buffers, next,
 102                                          vring->size, n_slots,
 103                                          vring->buffer_pool_index);
 104
 105   if (n_slots == 0)
 106     return;
 107
 108   while (n_slots)
 109     {
 110       struct vring_desc *d = &vring->desc[next];;
 111       vlib_buffer_t *b = vlib_get_buffer (vm, vring->buffers[next]);
 112       /*
 113        * current_data may not be initialized with 0 and may contain
 114        * previous offset. Here we want to make sure, it should be 0
 115        * initialized.
 116        */
 117       b->current_data = 0;
 118       b->current_data -= hdr_sz;
 119       memset (vlib_buffer_get_current (b), 0, hdr_sz);
 120       d->addr =
 121         ((vif->type == VIRTIO_IF_TYPE_PCI) ? vlib_buffer_get_current_pa (vm,
 122                                                                          b) :
 123          pointer_to_uword (vlib_buffer_get_current (b)));
 124       d->len = vlib_buffer_get_default_data_size (vm) + hdr_sz;
 125       d->flags = VRING_DESC_F_WRITE;
 126       vring->avail->ring[avail & mask] = next;
 127       avail++;
 128       next = (next + 1) & mask;
 129       n_slots--;
 130       used++;
 131     }
 132   CLIB_MEMORY_STORE_BARRIER ();
 133   vring->avail->idx = avail;
 134   vring->desc_next = next;
 135   vring->desc_in_use = used;
 136
 137   if ((vring->used->flags & VIRTIO_RING_FLAG_MASK_INT) == 0)
 138     {
 139       virtio_kick (vm, vring, vif);
 140     }
 141   goto more;
 142 }
 143
 144 static_always_inline void
 145 virtio_needs_csum (vlib_buffer_t * b0, struct virtio_net_hdr_v1 *hdr,
 146                    u8 * l4_proto, u8 * l4_hdr_sz, virtio_if_type_t type)
 147 {
 148   if (hdr->flags & VIRTIO_NET_HDR_F_NEEDS_CSUM)
 149
 150     {
 151       u16 ethertype = 0, l2hdr_sz = 0;
 152       if (type != VIRTIO_IF_TYPE_TUN)
 153         {
 154           ethernet_header_t *eh =
 155             (ethernet_header_t *) vlib_buffer_get_current (b0);
 156           ethertype = clib_net_to_host_u16 (eh->type);
 157           l2hdr_sz = sizeof (ethernet_header_t);
 158
 159           if (ethernet_frame_is_tagged (ethertype))
 160             {
 161               ethernet_vlan_header_t *vlan =
 162                 (ethernet_vlan_header_t *) (eh + 1);
 163
 164               ethertype = clib_net_to_host_u16 (vlan->type);
 165               l2hdr_sz += sizeof (*vlan);
 166               if (ethertype == ETHERNET_TYPE_VLAN)
 167                 {
 168                   vlan++;
 169                   ethertype = clib_net_to_host_u16 (vlan->type);
 170                   l2hdr_sz += sizeof (*vlan);
 171                 }
 172             }
 173         }
 174       else
 175         {
 176           switch (b0->data[0] & 0xf0)
 177             {
 178             case 0x40:
 179               ethertype = ETHERNET_TYPE_IP4;
 180               break;
 181             case 0x60:
 182               ethertype = ETHERNET_TYPE_IP6;
 183               break;
 184             }
 185         }
 186
 187       vnet_buffer (b0)->l2_hdr_offset = 0;
 188       vnet_buffer (b0)->l3_hdr_offset = l2hdr_sz;
 189       if (PREDICT_TRUE (ethertype == ETHERNET_TYPE_IP4))
 190         {
 191           ip4_header_t *ip4 =
 192             (ip4_header_t *) (vlib_buffer_get_current (b0) + l2hdr_sz);
 193           vnet_buffer (b0)->l4_hdr_offset = l2hdr_sz + ip4_header_bytes (ip4);
 194           *l4_proto = ip4->protocol;
 195           b0->flags |=
 196             (VNET_BUFFER_F_IS_IP4 | VNET_BUFFER_F_OFFLOAD_IP_CKSUM);
 197           b0->flags |=
 198             (VNET_BUFFER_F_L2_HDR_OFFSET_VALID
 199              | VNET_BUFFER_F_L3_HDR_OFFSET_VALID |
 200              VNET_BUFFER_F_L4_HDR_OFFSET_VALID);
 201         }
 202       else if (PREDICT_TRUE (ethertype == ETHERNET_TYPE_IP6))
 203         {
 204           ip6_header_t *ip6 =
 205             (ip6_header_t *) (vlib_buffer_get_current (b0) + l2hdr_sz);
 206           vnet_buffer (b0)->l4_hdr_offset = l2hdr_sz + sizeof (ip6_header_t);
 207           /* FIXME IPv6 EH traversal */
 208           *l4_proto = ip6->protocol;
 209           b0->flags |= (VNET_BUFFER_F_IS_IP6 |
 210                         VNET_BUFFER_F_L2_HDR_OFFSET_VALID
 211                         | VNET_BUFFER_F_L3_HDR_OFFSET_VALID |
 212                         VNET_BUFFER_F_L4_HDR_OFFSET_VALID);
 213         }
 214       if (*l4_proto == IP_PROTOCOL_TCP)
 215         {
 216           b0->flags |= VNET_BUFFER_F_OFFLOAD_TCP_CKSUM;
 217           tcp_header_t *tcp = (tcp_header_t *) (vlib_buffer_get_current (b0) +
 218                                                 vnet_buffer
 219                                                 (b0)->l4_hdr_offset);
 220           *l4_hdr_sz = tcp_header_bytes (tcp);
 221         }
 222       else if (*l4_proto == IP_PROTOCOL_UDP)
 223         {
 224           b0->flags |= VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
 225           udp_header_t *udp = (udp_header_t *) (vlib_buffer_get_current (b0) +
 226                                                 vnet_buffer
 227                                                 (b0)->l4_hdr_offset);
 228           *l4_hdr_sz = sizeof (*udp);
 229         }
 230     }
 231
 232 }
 233
 234 static_always_inline void
 235 fill_gso_buffer_flags (vlib_buffer_t * b0, struct virtio_net_hdr_v1 *hdr,
 236                        u8 l4_proto, u8 l4_hdr_sz)
 237 {
 238   if (hdr->gso_type == VIRTIO_NET_HDR_GSO_TCPV4)
 239     {
 240       ASSERT (hdr->flags & VIRTIO_NET_HDR_F_NEEDS_CSUM);
 241       vnet_buffer2 (b0)->gso_size = hdr->gso_size;
 242       vnet_buffer2 (b0)->gso_l4_hdr_sz = l4_hdr_sz;
 243       b0->flags |= VNET_BUFFER_F_GSO | VNET_BUFFER_F_IS_IP4;
 244     }
 245   if (hdr->gso_type == VIRTIO_NET_HDR_GSO_TCPV6)
 246     {
 247       ASSERT (hdr->flags & VIRTIO_NET_HDR_F_NEEDS_CSUM);
 248       vnet_buffer2 (b0)->gso_size = hdr->gso_size;
 249       vnet_buffer2 (b0)->gso_l4_hdr_sz = l4_hdr_sz;
 250       b0->flags |= VNET_BUFFER_F_GSO | VNET_BUFFER_F_IS_IP6;
 251     }
 252 }
 253
 254 static_always_inline uword
 255 virtio_device_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
 256                             vlib_frame_t * frame, virtio_if_t * vif, u16 qid,
 257                             int gso_enabled, int checksum_offload_enabled)
 258 {
 259   vnet_main_t *vnm = vnet_get_main ();
 260   u32 thread_index = vm->thread_index;
 261   uword n_trace = vlib_get_trace_count (vm, node);
 262   virtio_vring_t *vring = vec_elt_at_index (vif->rxq_vrings, qid);
 263   u32 next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
 264   const int hdr_sz = vif->virtio_net_hdr_sz;
 265   u32 *to_next = 0;
 266   u32 n_rx_packets = 0;
 267   u32 n_rx_bytes = 0;
 268   u16 mask = vring->size - 1;
 269   u16 last = vring->last_used_idx;
 270   u16 n_left = vring->used->idx - last;
 271
 272   if ((vring->used->flags & VIRTIO_RING_FLAG_MASK_INT) == 0 &&
 273       vring->last_kick_avail_idx != vring->avail->idx)
 274     virtio_kick (vm, vring, vif);
 275
 276   if (n_left == 0)
 277     goto refill;
 278
 279   while (n_left)
 280     {
 281       u32 n_left_to_next;
 282       u32 next0 = next_index;
 283       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 284
 285       while (n_left && n_left_to_next)
 286         {
 287           u8 l4_proto = 0, l4_hdr_sz = 0;
 288           u16 num_buffers = 1;
 289           struct vring_used_elem *e = &vring->used->ring[last & mask];
 290           struct virtio_net_hdr_v1 *hdr;
 291           u16 slot = e->id;
 292           u16 len = e->len - hdr_sz;
 293           u32 bi0 = vring->buffers[slot];
 294           vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
 295           hdr = vlib_buffer_get_current (b0);
 296           if (hdr_sz == sizeof (struct virtio_net_hdr_v1))
 297             num_buffers = hdr->num_buffers;
 298
 299           b0->current_data += hdr_sz;
 300           b0->current_length = len;
 301           b0->total_length_not_including_first_buffer = 0;
 302           b0->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID;
 303
 304           if (checksum_offload_enabled)
 305             virtio_needs_csum (b0, hdr, &l4_proto, &l4_hdr_sz, vif->type);
 306
 307           if (gso_enabled)
 308             fill_gso_buffer_flags (b0, hdr, l4_proto, l4_hdr_sz);
 309
 310           vnet_buffer (b0)->sw_if_index[VLIB_RX] = vif->sw_if_index;
 311           vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32) ~ 0;
 312
 313           /* if multisegment packet */
 314           if (PREDICT_FALSE (num_buffers > 1))
 315             {
 316               vlib_buffer_t *pb, *cb;
 317               pb = b0;
 318               while (num_buffers > 1)
 319                 {
 320                   last++;
 321                   e = &vring->used->ring[last & mask];
 322                   u32 cbi = vring->buffers[e->id];
 323                   cb = vlib_get_buffer (vm, cbi);
 324
 325                   /* current buffer */
 326                   cb->current_length = e->len;
 327
 328                   /* previous buffer */
 329                   pb->next_buffer = cbi;
 330                   pb->flags |= VLIB_BUFFER_NEXT_PRESENT;
 331
 332                   /* first buffer */
 333                   b0->total_length_not_including_first_buffer += e->len;
 334
 335                   pb = cb;
 336                   vring->desc_in_use--;
 337                   num_buffers--;
 338                   n_left--;
 339                 }
 340             }
 341           if (PREDICT_FALSE (vif->type == VIRTIO_IF_TYPE_TUN))
 342             {
 343               switch (b0->data[0] & 0xf0)
 344                 {
 345                 case 0x40:
 346                   next0 = VNET_DEVICE_INPUT_NEXT_IP4_INPUT;
 347                   break;
 348                 case 0x60:
 349                   next0 = VNET_DEVICE_INPUT_NEXT_IP6_INPUT;
 350                   break;
 351                 default:
 352                   next0 = VNET_DEVICE_INPUT_NEXT_DROP;
 353                   break;
 354                 }
 355             }
 356
 357
 358           if (PREDICT_FALSE (vif->per_interface_next_index != ~0))
 359             next0 = vif->per_interface_next_index;
 360
 361           /* redirect if feature path enabled */
 362           vnet_feature_start_device_input_x1 (vif->sw_if_index, &next0, b0);
 363
 364           /* trace */
 365           VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
 366
 367           if (PREDICT_FALSE (n_trace > 0))
 368             {
 369               virtio_input_trace_t *tr;
 370               vlib_trace_buffer (vm, node, next0, b0,
 371                                  /* follow_chain */ 1);
 372               vlib_set_trace_count (vm, node, --n_trace);
 373               tr = vlib_add_trace (vm, node, b0, sizeof (*tr));
 374               tr->next_index = next0;
 375               tr->hw_if_index = vif->hw_if_index;
 376               tr->len = len + b0->total_length_not_including_first_buffer;
 377               clib_memcpy_fast (&tr->hdr, hdr, hdr_sz);
 378             }
 379
 380           /* enqueue buffer */
 381           to_next[0] = bi0;
 382           vring->desc_in_use--;
 383           to_next += 1;
 384           n_left_to_next--;
 385           n_left--;
 386           last++;
 387
 388           /* enqueue */
 389           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
 390                                            n_left_to_next, bi0, next0);
 391
 392           /* next packet */
 393           n_rx_packets++;
 394           n_rx_bytes += (len + b0->total_length_not_including_first_buffer);
 395         }
 396       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 397     }
 398   vring->last_used_idx = last;
 399
 400   vlib_increment_combined_counter (vnm->interface_main.combined_sw_if_counters
 401                                    + VNET_INTERFACE_COUNTER_RX, thread_index,
 402                                    vif->sw_if_index, n_rx_packets,
 403                                    n_rx_bytes);
 404
 405 refill:
 406   virtio_refill_vring (vm, vif, vring, hdr_sz);
 407
 408   return n_rx_packets;
 409 }
 410
 411 VLIB_NODE_FN (virtio_input_node) (vlib_main_t * vm,
 412                                   vlib_node_runtime_t * node,
 413                                   vlib_frame_t * frame)
 414 {
 415   u32 n_rx = 0;
 416   virtio_main_t *nm = &virtio_main;
 417   vnet_device_input_runtime_t *rt = (void *) node->runtime_data;
 418   vnet_device_and_queue_t *dq;
 419
 420   foreach_device_and_queue (dq, rt->devices_and_queues)
 421   {
 422     virtio_if_t *vif;
 423     vif = vec_elt_at_index (nm->interfaces, dq->dev_instance);
 424     if (vif->flags & VIRTIO_IF_FLAG_ADMIN_UP)
 425       {
 426         if (vif->gso_enabled)
 427           n_rx += virtio_device_input_inline (vm, node, frame, vif,
 428                                               dq->queue_id, 1, 1);
 429         else if (vif->csum_offload_enabled)
 430           n_rx += virtio_device_input_inline (vm, node, frame, vif,
 431                                               dq->queue_id, 0, 1);
 432         else
 433           n_rx += virtio_device_input_inline (vm, node, frame, vif,
 434                                               dq->queue_id, 0, 0);
 435       }
 436   }
 437
 438   return n_rx;
 439 }
 440
 441 /* *INDENT-OFF* */
 442 VLIB_REGISTER_NODE (virtio_input_node) = {
 443   .name = "virtio-input",
 444   .sibling_of = "device-input",
 445   .format_trace = format_virtio_input_trace,
 446   .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
 447   .type = VLIB_NODE_TYPE_INPUT,
 448   .state = VLIB_NODE_STATE_INTERRUPT,
 449   .n_errors = VIRTIO_INPUT_N_ERROR,
 450   .error_strings = virtio_input_error_strings,
 451 };
 452 /* *INDENT-ON* */
 453
 454 /*
 455  * fd.io coding-style-patch-verification: ON
 456  *
 457  * Local Variables:
 458  * eval: (c-set-style "gnu")
 459  * End:
 460  */