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