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