src/plugins/dpdk/device/node.c

   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 #include <vnet/vnet.h>
  16 #include <vppinfra/vec.h>
  17 #include <vppinfra/error.h>
  18 #include <vppinfra/format.h>
  19 #include <vppinfra/xxhash.h>
  20
  21 #include <vnet/ethernet/ethernet.h>
  22 #include <dpdk/buffer.h>
  23 #include <dpdk/device/dpdk.h>
  24 #include <vnet/classify/vnet_classify.h>
  25 #include <vnet/mpls/packet.h>
  26 #include <vnet/devices/devices.h>
  27 #include <vnet/interface/rx_queue_funcs.h>
  28 #include <vnet/feature/feature.h>
  29
  30 #include <dpdk/device/dpdk_priv.h>
  31
  32 static char *dpdk_error_strings[] = {
  33 #define _(n,s) s,
  34   foreach_dpdk_error
  35 #undef _
  36 };
  37
  38 /* make sure all flags we need are stored in lower 32 bits */
  39 STATIC_ASSERT ((u64) (PKT_RX_IP_CKSUM_BAD | PKT_RX_FDIR | PKT_RX_LRO) <
  40                  (1ULL << 32),
  41                "dpdk flags not in lower word, fix needed");
  42
  43 static_always_inline uword
  44 dpdk_process_subseq_segs (vlib_main_t * vm, vlib_buffer_t * b,
  45                           struct rte_mbuf *mb, vlib_buffer_t * bt)
  46 {
  47   u8 nb_seg = 1;
  48   struct rte_mbuf *mb_seg = 0;
  49   vlib_buffer_t *b_seg, *b_chain = 0;
  50   mb_seg = mb->next;
  51   b_chain = b;
  52
  53   if (mb->nb_segs < 2)
  54     return 0;
  55
  56   b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
  57   b->total_length_not_including_first_buffer = 0;
  58
  59   while (nb_seg < mb->nb_segs)
  60     {
  61       ASSERT (mb_seg != 0);
  62
  63       b_seg = vlib_buffer_from_rte_mbuf (mb_seg);
  64       vlib_buffer_copy_template (b_seg, bt);
  65
  66       /*
  67        * The driver (e.g. virtio) may not put the packet data at the start
  68        * of the segment, so don't assume b_seg->current_data == 0 is correct.
  69        */
  70       b_seg->current_data =
  71         (mb_seg->buf_addr + mb_seg->data_off) - (void *) b_seg->data;
  72
  73       b_seg->current_length = mb_seg->data_len;
  74       b->total_length_not_including_first_buffer += mb_seg->data_len;
  75
  76       b_chain->flags |= VLIB_BUFFER_NEXT_PRESENT;
  77       b_chain->next_buffer = vlib_get_buffer_index (vm, b_seg);
  78
  79       b_chain = b_seg;
  80       mb_seg = mb_seg->next;
  81       nb_seg++;
  82     }
  83   return b->total_length_not_including_first_buffer;
  84 }
  85
  86 static_always_inline void
  87 dpdk_prefetch_mbuf_x4 (struct rte_mbuf *mb[])
  88 {
  89   clib_prefetch_load (mb[0]);
  90   clib_prefetch_load (mb[1]);
  91   clib_prefetch_load (mb[2]);
  92   clib_prefetch_load (mb[3]);
  93 }
  94
  95 static_always_inline void
  96 dpdk_prefetch_buffer_x4 (struct rte_mbuf *mb[])
  97 {
  98   vlib_buffer_t *b;
  99   b = vlib_buffer_from_rte_mbuf (mb[0]);
 100   clib_prefetch_store (b);
 101   b = vlib_buffer_from_rte_mbuf (mb[1]);
 102   clib_prefetch_store (b);
 103   b = vlib_buffer_from_rte_mbuf (mb[2]);
 104   clib_prefetch_store (b);
 105   b = vlib_buffer_from_rte_mbuf (mb[3]);
 106   clib_prefetch_store (b);
 107 }
 108
 109 /** \brief Main DPDK input node
 110     @node dpdk-input
 111
 112     This is the main DPDK input node: across each assigned interface,
 113     call rte_eth_rx_burst(...) or similar to obtain a vector of
 114     packets to process. Derive @c vlib_buffer_t metadata from
 115     <code>struct rte_mbuf</code> metadata,
 116     Depending on the resulting metadata: adjust <code>b->current_data,
 117     b->current_length </code> and dispatch directly to
 118     ip4-input-no-checksum, or ip6-input. Trace the packet if required.
 119
 120     @param vm   vlib_main_t corresponding to the current thread
 121     @param node vlib_node_runtime_t
 122     @param f    vlib_frame_t input-node, not used.
 123
 124     @par Graph mechanics: buffer metadata, next index usage
 125
 126     @em Uses:
 127     - <code>struct rte_mbuf mb->ol_flags</code>
 128         - PKT_RX_IP_CKSUM_BAD
 129
 130     @em Sets:
 131     - <code>b->error</code> if the packet is to be dropped immediately
 132     - <code>b->current_data, b->current_length</code>
 133         - adjusted as needed to skip the L2 header in  direct-dispatch cases
 134     - <code>vnet_buffer(b)->sw_if_index[VLIB_RX]</code>
 135         - rx interface sw_if_index
 136     - <code>vnet_buffer(b)->sw_if_index[VLIB_TX] = ~0</code>
 137         - required by ipX-lookup
 138     - <code>b->flags</code>
 139         - to indicate multi-segment pkts (VLIB_BUFFER_NEXT_PRESENT), etc.
 140
 141     <em>Next Nodes:</em>
 142     - Static arcs to: error-drop, ethernet-input,
 143       ip4-input-no-checksum, ip6-input, mpls-input
 144     - per-interface redirection, controlled by
 145       <code>xd->per_interface_next_index</code>
 146 */
 147
 148 static_always_inline u32
 149 dpdk_ol_flags_extract (struct rte_mbuf **mb, u32 *flags, int count)
 150 {
 151   u32 rv = 0;
 152   int i;
 153   for (i = 0; i < count; i++)
 154     {
 155       /* all flags we are interested in are in lower 8 bits but
 156          that might change */
 157       flags[i] = (u32) mb[i]->ol_flags;
 158       rv |= flags[i];
 159     }
 160   return rv;
 161 }
 162
 163 static_always_inline uword
 164 dpdk_process_rx_burst (vlib_main_t *vm, dpdk_per_thread_data_t *ptd,
 165                        uword n_rx_packets, int maybe_multiseg, u32 *or_flagsp)
 166 {
 167   u32 n_left = n_rx_packets;
 168   vlib_buffer_t *b[4];
 169   struct rte_mbuf **mb = ptd->mbufs;
 170   uword n_bytes = 0;
 171   u32 *flags, or_flags = 0;
 172   vlib_buffer_t bt;
 173
 174   mb = ptd->mbufs;
 175   flags = ptd->flags;
 176
 177   /* copy template into local variable - will save per packet load */
 178   vlib_buffer_copy_template (&bt, &ptd->buffer_template);
 179   while (n_left >= 8)
 180     {
 181       dpdk_prefetch_buffer_x4 (mb + 4);
 182
 183       b[0] = vlib_buffer_from_rte_mbuf (mb[0]);
 184       b[1] = vlib_buffer_from_rte_mbuf (mb[1]);
 185       b[2] = vlib_buffer_from_rte_mbuf (mb[2]);
 186       b[3] = vlib_buffer_from_rte_mbuf (mb[3]);
 187
 188       vlib_buffer_copy_template (b[0], &bt);
 189       vlib_buffer_copy_template (b[1], &bt);
 190       vlib_buffer_copy_template (b[2], &bt);
 191       vlib_buffer_copy_template (b[3], &bt);
 192
 193       dpdk_prefetch_mbuf_x4 (mb + 4);
 194
 195       or_flags |= dpdk_ol_flags_extract (mb, flags, 4);
 196       flags += 4;
 197
 198       b[0]->current_data = mb[0]->data_off - RTE_PKTMBUF_HEADROOM;
 199       n_bytes += b[0]->current_length = mb[0]->data_len;
 200
 201       b[1]->current_data = mb[1]->data_off - RTE_PKTMBUF_HEADROOM;
 202       n_bytes += b[1]->current_length = mb[1]->data_len;
 203
 204       b[2]->current_data = mb[2]->data_off - RTE_PKTMBUF_HEADROOM;
 205       n_bytes += b[2]->current_length = mb[2]->data_len;
 206
 207       b[3]->current_data = mb[3]->data_off - RTE_PKTMBUF_HEADROOM;
 208       n_bytes += b[3]->current_length = mb[3]->data_len;
 209
 210       if (maybe_multiseg)
 211         {
 212           n_bytes += dpdk_process_subseq_segs (vm, b[0], mb[0], &bt);
 213           n_bytes += dpdk_process_subseq_segs (vm, b[1], mb[1], &bt);
 214           n_bytes += dpdk_process_subseq_segs (vm, b[2], mb[2], &bt);
 215           n_bytes += dpdk_process_subseq_segs (vm, b[3], mb[3], &bt);
 216         }
 217
 218       /* next */
 219       mb += 4;
 220       n_left -= 4;
 221     }
 222
 223   while (n_left)
 224     {
 225       b[0] = vlib_buffer_from_rte_mbuf (mb[0]);
 226       vlib_buffer_copy_template (b[0], &bt);
 227       or_flags |= dpdk_ol_flags_extract (mb, flags, 1);
 228       flags += 1;
 229
 230       b[0]->current_data = mb[0]->data_off - RTE_PKTMBUF_HEADROOM;
 231       n_bytes += b[0]->current_length = mb[0]->data_len;
 232
 233       if (maybe_multiseg)
 234         n_bytes += dpdk_process_subseq_segs (vm, b[0], mb[0], &bt);
 235
 236       /* next */
 237       mb += 1;
 238       n_left -= 1;
 239     }
 240
 241   *or_flagsp = or_flags;
 242   return n_bytes;
 243 }
 244
 245 static_always_inline void
 246 dpdk_process_flow_offload (dpdk_device_t * xd, dpdk_per_thread_data_t * ptd,
 247                            uword n_rx_packets)
 248 {
 249   uword n;
 250   dpdk_flow_lookup_entry_t *fle;
 251   vlib_buffer_t *b0;
 252
 253   /* TODO prefetch and quad-loop */
 254   for (n = 0; n < n_rx_packets; n++)
 255     {
 256       if ((ptd->flags[n] & PKT_RX_FDIR_ID) == 0)
 257         continue;
 258
 259       fle = pool_elt_at_index (xd->flow_lookup_entries,
 260                                ptd->mbufs[n]->hash.fdir.hi);
 261
 262       if (fle->next_index != (u16) ~ 0)
 263         ptd->next[n] = fle->next_index;
 264
 265       if (fle->flow_id != ~0)
 266         {
 267           b0 = vlib_buffer_from_rte_mbuf (ptd->mbufs[n]);
 268           b0->flow_id = fle->flow_id;
 269         }
 270
 271       if (fle->buffer_advance != ~0)
 272         {
 273           b0 = vlib_buffer_from_rte_mbuf (ptd->mbufs[n]);
 274           vlib_buffer_advance (b0, fle->buffer_advance);
 275         }
 276     }
 277 }
 278
 279 static_always_inline u16
 280 dpdk_lro_find_l4_hdr_sz (vlib_buffer_t *b)
 281 {
 282   u16 l4_hdr_sz = 0;
 283   u16 current_offset = 0;
 284   ethernet_header_t *e;
 285   tcp_header_t *tcp;
 286   u8 *data = vlib_buffer_get_current (b);
 287   u16 ethertype;
 288   e = (void *) data;
 289   current_offset += sizeof (e[0]);
 290   ethertype = clib_net_to_host_u16 (e->type);
 291   if (ethernet_frame_is_tagged (ethertype))
 292     {
 293       ethernet_vlan_header_t *vlan = (ethernet_vlan_header_t *) (e + 1);
 294       ethertype = clib_net_to_host_u16 (vlan->type);
 295       current_offset += sizeof (*vlan);
 296       if (ethertype == ETHERNET_TYPE_VLAN)
 297         {
 298           vlan++;
 299           current_offset += sizeof (*vlan);
 300           ethertype = clib_net_to_host_u16 (vlan->type);
 301         }
 302     }
 303   data += current_offset;
 304   if (ethertype == ETHERNET_TYPE_IP4)
 305     {
 306       data += sizeof (ip4_header_t);
 307       tcp = (void *) data;
 308       l4_hdr_sz = tcp_header_bytes (tcp);
 309     }
 310   else
 311     {
 312       /* FIXME: extension headers...*/
 313       data += sizeof (ip6_header_t);
 314       tcp = (void *) data;
 315       l4_hdr_sz = tcp_header_bytes (tcp);
 316     }
 317   return l4_hdr_sz;
 318 }
 319
 320 static_always_inline void
 321 dpdk_process_lro_offload (dpdk_device_t *xd, dpdk_per_thread_data_t *ptd,
 322                           uword n_rx_packets)
 323 {
 324   uword n;
 325   vlib_buffer_t *b0;
 326   for (n = 0; n < n_rx_packets; n++)
 327     {
 328       b0 = vlib_buffer_from_rte_mbuf (ptd->mbufs[n]);
 329       if (ptd->flags[n] & PKT_RX_LRO)
 330         {
 331           b0->flags |= VNET_BUFFER_F_GSO;
 332           vnet_buffer2 (b0)->gso_size = ptd->mbufs[n]->tso_segsz;
 333           vnet_buffer2 (b0)->gso_l4_hdr_sz = dpdk_lro_find_l4_hdr_sz (b0);
 334         }
 335     }
 336 }
 337
 338 static_always_inline u32
 339 dpdk_device_input (vlib_main_t * vm, dpdk_main_t * dm, dpdk_device_t * xd,
 340                    vlib_node_runtime_t * node, u32 thread_index, u16 queue_id)
 341 {
 342   uword n_rx_packets = 0, n_rx_bytes;
 343   dpdk_rx_queue_t *rxq = vec_elt_at_index (xd->rx_queues, queue_id);
 344   u32 n_left, n_trace;
 345   u32 *buffers;
 346   u32 next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
 347   struct rte_mbuf **mb;
 348   vlib_buffer_t *b0;
 349   u16 *next;
 350   u32 or_flags;
 351   u32 n;
 352   int single_next = 0;
 353
 354   dpdk_per_thread_data_t *ptd = vec_elt_at_index (dm->per_thread_data,
 355                                                   thread_index);
 356   vlib_buffer_t *bt = &ptd->buffer_template;
 357
 358   if ((xd->flags & DPDK_DEVICE_FLAG_ADMIN_UP) == 0)
 359     return 0;
 360
 361   /* get up to DPDK_RX_BURST_SZ buffers from PMD */
 362   while (n_rx_packets < DPDK_RX_BURST_SZ)
 363     {
 364       n = rte_eth_rx_burst (xd->port_id, queue_id,
 365                             ptd->mbufs + n_rx_packets,
 366                             DPDK_RX_BURST_SZ - n_rx_packets);
 367       n_rx_packets += n;
 368
 369       if (n < 32)
 370         break;
 371     }
 372
 373   if (n_rx_packets == 0)
 374     return 0;
 375
 376   /* Update buffer template */
 377   vnet_buffer (bt)->sw_if_index[VLIB_RX] = xd->sw_if_index;
 378   bt->error = node->errors[DPDK_ERROR_NONE];
 379   bt->flags = xd->buffer_flags;
 380   /* as DPDK is allocating empty buffers from mempool provided before interface
 381      start for each queue, it is safe to store this in the template */
 382   bt->buffer_pool_index = rxq->buffer_pool_index;
 383   bt->ref_count = 1;
 384   vnet_buffer (bt)->feature_arc_index = 0;
 385   bt->current_config_index = 0;
 386
 387   /* receive burst of packets from DPDK PMD */
 388   if (PREDICT_FALSE (xd->per_interface_next_index != ~0))
 389     next_index = xd->per_interface_next_index;
 390
 391   /* as all packets belong to the same interface feature arc lookup
 392      can be don once and result stored in the buffer template */
 393   if (PREDICT_FALSE (vnet_device_input_have_features (xd->sw_if_index)))
 394     vnet_feature_start_device_input_x1 (xd->sw_if_index, &next_index, bt);
 395
 396   if (xd->flags & DPDK_DEVICE_FLAG_MAYBE_MULTISEG)
 397     n_rx_bytes = dpdk_process_rx_burst (vm, ptd, n_rx_packets, 1, &or_flags);
 398   else
 399     n_rx_bytes = dpdk_process_rx_burst (vm, ptd, n_rx_packets, 0, &or_flags);
 400
 401   if (PREDICT_FALSE ((or_flags & PKT_RX_LRO)))
 402     dpdk_process_lro_offload (xd, ptd, n_rx_packets);
 403
 404   if (PREDICT_FALSE (or_flags & PKT_RX_FDIR))
 405     {
 406       /* some packets will need to go to different next nodes */
 407       for (n = 0; n < n_rx_packets; n++)
 408         ptd->next[n] = next_index;
 409
 410       /* flow offload - process if rx flow offload enabled and at least one
 411          packet is marked */
 412       if (PREDICT_FALSE ((xd->flags & DPDK_DEVICE_FLAG_RX_FLOW_OFFLOAD) &&
 413                          (or_flags & PKT_RX_FDIR)))
 414         dpdk_process_flow_offload (xd, ptd, n_rx_packets);
 415
 416       /* enqueue buffers to the next node */
 417       vlib_get_buffer_indices_with_offset (vm, (void **) ptd->mbufs,
 418                                            ptd->buffers, n_rx_packets,
 419                                            sizeof (struct rte_mbuf));
 420
 421       vlib_buffer_enqueue_to_next (vm, node, ptd->buffers, ptd->next,
 422                                    n_rx_packets);
 423     }
 424   else
 425     {
 426       u32 *to_next, n_left_to_next;
 427
 428       vlib_get_new_next_frame (vm, node, next_index, to_next, n_left_to_next);
 429       vlib_get_buffer_indices_with_offset (vm, (void **) ptd->mbufs, to_next,
 430                                            n_rx_packets,
 431                                            sizeof (struct rte_mbuf));
 432
 433       if (PREDICT_TRUE (next_index == VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT))
 434         {
 435           vlib_next_frame_t *nf;
 436           vlib_frame_t *f;
 437           ethernet_input_frame_t *ef;
 438           nf = vlib_node_runtime_get_next_frame (vm, node, next_index);
 439           f = vlib_get_frame (vm, nf->frame);
 440           f->flags = ETH_INPUT_FRAME_F_SINGLE_SW_IF_IDX;
 441
 442           ef = vlib_frame_scalar_args (f);
 443           ef->sw_if_index = xd->sw_if_index;
 444           ef->hw_if_index = xd->hw_if_index;
 445
 446           /* if PMD supports ip4 checksum check and there are no packets
 447              marked as ip4 checksum bad we can notify ethernet input so it
 448              can send pacets to ip4-input-no-checksum node */
 449           if (xd->flags & DPDK_DEVICE_FLAG_RX_IP4_CKSUM &&
 450               (or_flags & PKT_RX_IP_CKSUM_BAD) == 0)
 451             f->flags |= ETH_INPUT_FRAME_F_IP4_CKSUM_OK;
 452           vlib_frame_no_append (f);
 453         }
 454       n_left_to_next -= n_rx_packets;
 455       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 456       single_next = 1;
 457     }
 458
 459   /* packet trace if enabled */
 460   if (PREDICT_FALSE ((n_trace = vlib_get_trace_count (vm, node))))
 461     {
 462       if (single_next)
 463         vlib_get_buffer_indices_with_offset (vm, (void **) ptd->mbufs,
 464                                              ptd->buffers, n_rx_packets,
 465                                              sizeof (struct rte_mbuf));
 466
 467       n_left = n_rx_packets;
 468       buffers = ptd->buffers;
 469       mb = ptd->mbufs;
 470       next = ptd->next;
 471
 472       while (n_trace && n_left)
 473         {
 474           b0 = vlib_get_buffer (vm, buffers[0]);
 475           if (single_next == 0)
 476             next_index = next[0];
 477
 478           if (PREDICT_TRUE
 479               (vlib_trace_buffer
 480                (vm, node, next_index, b0, /* follow_chain */ 0)))
 481             {
 482
 483               dpdk_rx_trace_t *t0 =
 484                 vlib_add_trace (vm, node, b0, sizeof t0[0]);
 485               t0->queue_index = queue_id;
 486               t0->device_index = xd->device_index;
 487               t0->buffer_index = vlib_get_buffer_index (vm, b0);
 488
 489               clib_memcpy_fast (&t0->mb, mb[0], sizeof t0->mb);
 490               clib_memcpy_fast (&t0->buffer, b0,
 491                                 sizeof b0[0] - sizeof b0->pre_data);
 492               clib_memcpy_fast (t0->buffer.pre_data, b0->data,
 493                                 sizeof t0->buffer.pre_data);
 494               clib_memcpy_fast (&t0->data, mb[0]->buf_addr + mb[0]->data_off,
 495                                 sizeof t0->data);
 496               n_trace--;
 497             }
 498
 499           n_left--;
 500           buffers++;
 501           mb++;
 502           next++;
 503         }
 504       vlib_set_trace_count (vm, node, n_trace);
 505     }
 506
 507   vlib_increment_combined_counter
 508     (vnet_get_main ()->interface_main.combined_sw_if_counters
 509      + VNET_INTERFACE_COUNTER_RX, thread_index, xd->sw_if_index,
 510      n_rx_packets, n_rx_bytes);
 511
 512   vnet_device_increment_rx_packets (thread_index, n_rx_packets);
 513
 514   return n_rx_packets;
 515 }
 516
 517 VLIB_NODE_FN (dpdk_input_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
 518                                 vlib_frame_t * f)
 519 {
 520   dpdk_main_t *dm = &dpdk_main;
 521   dpdk_device_t *xd;
 522   uword n_rx_packets = 0;
 523   vnet_hw_if_rxq_poll_vector_t *pv;
 524   u32 thread_index = node->thread_index;
 525
 526   /*
 527    * Poll all devices on this cpu for input/interrupts.
 528    */
 529
 530   pv = vnet_hw_if_get_rxq_poll_vector (vm, node);
 531
 532   for (int i = 0; i < vec_len (pv); i++)
 533     {
 534       xd = vec_elt_at_index (dm->devices, pv[i].dev_instance);
 535       n_rx_packets +=
 536         dpdk_device_input (vm, dm, xd, node, thread_index, pv[i].queue_id);
 537     }
 538   return n_rx_packets;
 539 }
 540
 541 /* *INDENT-OFF* */
 542 VLIB_REGISTER_NODE (dpdk_input_node) = {
 543   .type = VLIB_NODE_TYPE_INPUT,
 544   .name = "dpdk-input",
 545   .sibling_of = "device-input",
 546   .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
 547
 548   /* Will be enabled if/when hardware is detected. */
 549   .state = VLIB_NODE_STATE_DISABLED,
 550
 551   .format_buffer = format_ethernet_header_with_length,
 552   .format_trace = format_dpdk_rx_trace,
 553
 554   .n_errors = DPDK_N_ERROR,
 555   .error_strings = dpdk_error_strings,
 556 };
 557 /* *INDENT-ON* */
 558
 559 /*
 560  * fd.io coding-style-patch-verification: ON
 561  *
 562  * Local Variables:
 563  * eval: (c-set-style "gnu")
 564  * End:
 565  */