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